Saltar para o conteúdo principal
Versão: 20 R9 BETA

Session

Os objetos de sessão são retornados pelo comando Session. Esses objetos fornecem ao desenvolvedor uma interface que permite gerenciar a sessão atual do usuário e executar ações como armazenar dados contextuais, compartilhar informações entre processos de sessão, iniciar processos preemptivos relacionados à sessão ou (somente na Web) gerenciar privilégios.

Tipos de sessão

Os seguintes tipos de sessões são suportados por essa classe:

nota

A disponibilidade de propriedades e funções no objeto Session depende do tipo de sessão.

Resumo

.clearPrivileges() : Boolean
remove todos os privilégios associados à sessão e retorna True se a execução foi bem-sucedida
.createOTP ( { lifespan : Integer } ) : Text
cria um novo OTP (uma senha única) para a sessão e retorna seu UUID
.expirationDate : Text
a data e a hora de expiração do cookie de sessão
.getPrivileges() : Collection
retorna uma coleção de todos os nomes de privilégios associados à sessão
.hasPrivilege( privilege : Text ) : Boolean
retorna True se o privilege estiver associado à sessão e False caso contrário
.id : Text
o identificador único (UUID) da sessão do usuário
.idleTimeout : Integer
the inactivity session timeout (in minutes), after which the session is automatically closed by 4D
.info : Object
descreve o cliente remoto ou a sessão do procedimento armazenado no servidor, ou a sessão autônoma
.isGuest() : Boolean
returns True if the session is a Guest session (i.e. it has no privileges)
.restore ( token : Text ) : Boolean
substitui a sessão do usuário da web pela sua sessão original correspondente ao token UUID
.setPrivileges( privilege : Text ) : Boolean
.setPrivileges( privileges : Collection )
.setPrivileges( settings : Object ) : Boolean

associa os privilégios e/ou papéis definidos no parâmetro para a sessão e retorna True se a execução foi bem sucedida
.storage : Object
um objeto compartilhado que pode ser usado para armazenar informações disponíveis para todos os processos da sessão
.userName : Text
o nome de usuário associado à sessão

.clearPrivileges()

História
ReleaseMudanças
18 R6Adicionado

.clearPrivileges() : Boolean

ParâmetroTipoDescrição
ResultadosParâmetros<-True se a execução for bem-sucedida

Descrição

nota

Esta função não faz nada e sempre retorna Verdadeiro com cliente remoto, procedimento armazenado e sessões autônomas.

A função .clearPrivileges() remove todos os privilégios associados à sessão e retorna True se a execução foi bem-sucedida. A menos que esteja no modo "forceLogin", a sessão se torna automaticamente uma sessão de convidado.

nota

No modo "forceLogin", .clearPrivileges() não transforma a sessão em uma sessão Guest, apenas limpa os privilégios da sessão.

Exemplo

//Invalidar uma sessão de usuário da web
var $isGuest : Boolean
var $isOK : Boolean

$isOK:=Session.clearPrivileges()
$isGuest:=Session.isGuest() //$isGuest é True

.createOTP()

História
ReleaseMudanças
20 R9Adicionado

.createOTP ( { lifespan : Integer } ) : Text

ParâmetroTipoDescrição
lifespanInteger->Duração do token de sessão em segundos
ResultadosText<-UUID da sessão

Descrição

nota

Essa função só está disponível com sessões de usuário Web. Ele retorna uma string vazia em outros contextos.

A função .createOTP() cria um novo OTP (uma senha única) para a sessão e retorna seu UUID. Esse token é exclusivo da sessão em que foi gerado.

Para mais informações sobre os tokens OTP, consulte esta seção.

Por padrão, se o parâmetro lifespan for omitido, o token será criado com o mesmo tempo de vida que o .idleTimeOut da sessão. Você pode definir um tempo limite personalizado passando um valor em segundos em lifespan (o valor mínimo é 10 segundos, lifespan é redefinido para 10 se um valor menor for passado). Se um token expirado for usado para restaurar uma sessão de usuário Web, ele será ignorado.

O token retornado pode então ser usado em trocas com aplicativos ou sites de terceiros para identificar a sessão com segurança. For example, the session OTP token can be used with a payment application.

Exemplo

var $token : Text
$token := Session.createOTP( 60 ) //o token é válido por 1 mn

.expirationDate

História
ReleaseMudanças
18 R6Adicionado

.expirationDate : Text

Descrição

nota

Essa propriedade só está disponível com sessões de usuário da Web.

A propriedade .expirationDate contém a data e a hora de expiração do cookie de sessão. O valor é expresso como texto no formato ISO 8601: YYYY-MM-DDTHH:MM:SS.mmmZ.

Essa propriedade é somente leitura. Ele será automaticamente recalculado se o valor da propriedade .idleTimeout for modificado.

Exemplo

var $expiration : Text
$expiration:=Session.expirationDate //por exemplo "2021-11-05T17:10:42Z"

.getPrivileges()

História
ReleaseMudanças
20 R6Adicionado

.getPrivileges() : Collection

ParâmetroTipoDescrição
ResultadosCollection<-Coleção de nomes de privilégios (strings)

Descrição

A função .getPrivileges() retorna uma coleção de todos os nomes de privilégios associados à sessão.

Com cliente remoto, procedimento armazenado e sessões autônomas, essa função retorna uma coleção que contém apenas "WebAdmin".

info

Os privilégios são atribuídos a uma sessão usando a função setPrivileges().

Exemplo

O seguinte arquivo roles.json foi definido:

{
"privileges":[
{
"privilege":"simple",
"includes":[

]
},
{
"privilege":"medium",
"includes":[
"simple"
]
}
],
"roles":[
{
"role":"Medium",
"privileges":[
"medium"
]
}
],
"permissions":{
"allowed":[

]
}
}

O papel de sessão é atribuído em uma função de datastore authentify():

  //Datastore Class

exposed Function authentify($role : Text) : Text
Session.clearPrivileges()
Session.setPrivileges({roles: $role})

Assumindo que a função authentify() seja chamada com o papel "Medium":

var $privileges : Collection
$privileges := Session.getPrivileges()
//$privileges: ["simple","medium"]

Veja também

.setPrivileges()
Permissions – Inspect the privileges in the session for an easy debugging (blog post)

.hasPrivilege()

História
ReleaseMudanças
18 R6Adicionado

.hasPrivilege( privilege : Text ) : Boolean

ParâmetroTipoDescrição
privilegeText->Nome do privilegio a verificar
ResultadosParâmetros<-True se a sessão tiver privilege, False caso contrário

Descrição

A função .hasPrivilege() retorna True se o privilege estiver associado à sessão e False caso contrário.

Com cliente remoto, procedimento armazenado e sessões autônomas, essa função sempre retorna True, independentemente do privilégio.

Exemplo

You want to check if the "WebAdmin" privilege is associated to the web user session:

If (Session.hasPrivilege("WebAdmin"))
//Acesso é concedido, não faça nada
Else
//Exibe uma página de autenticação

End if

.id

História
ReleaseMudanças
20 R5Adicionado

.id : Text

Descrição

A propriedade .id contém o identificador único (UUID) da sessão do usuário. Com o 4D Server, essa string exclusiva é atribuída automaticamente pelo servidor para cada sessão e permite que você identifique seus processos.

tip

Você pode usar essa propriedade para obter o objeto .storage de uma sessão graças ao comando storage.

.idleTimeout

História
ReleaseMudanças

|v18 R6|Adicionado|

.idleTimeout : Integer

Descrição

nota

Essa propriedade só está disponível com sessões de usuário da Web.

The .idleTimeout property contains the inactivity session timeout (in minutes), after which the session is automatically closed by 4D.

Se não se definir esta propriedade, o valor padrão é 60 (1h).

Quando essa propriedade é definida, a propriedade .expirationDate é atualizada de acordo.

O valor não pode ser inferior a 60: se definir um valor inferior, o tempo de espera se eleva até 60.

Essa propriedade é leitura escrita.

Exemplo

If (Session.isGuest())
// A Guest session will close after 60 minutes of inactivity
Session.idleTimeout:=60
Else
// Other sessions will close after 120 minutes of inactivity
Session.idleTimeout:=120
End if

.info

História
ReleaseMudanças
20 R5Adicionado

.info : Object

Descrição

nota

Essa propriedade só está disponível com cliente remoto, procedimento armazenado e sessões autônomas.

A propriedade .info descreve o cliente remoto ou a sessão do procedimento armazenado no servidor, ou a sessão autônoma.

nota
  • O objeto .info é o mesmo objeto retornado na propriedade "session" pelo comando Process activity para sessões de procedimento armazenado e cliente remoto.
  • O objeto .info é o mesmo objeto retornado pelo comando Session info para uma sessão autônoma.

The .info object contains the following properties:

PropriedadeTipoDescrição
typeTextTipo de sessão: "remote", "storedProcedure", "standalone"
userNameTextNome de usuário 4D (o mesmo valor que .userName)
machineNameTextSessões remotas: nome da máquina remota. Sessão de procedimentos armazenados: nome da máquina do servidor. Sessão autônoma: nome da máquina
systemUserNameTextSessões remotas: nome da sessão do sistema aberta na máquina remota.
IPAddressTextEndereço IP da máquina remota
hostTypeTextTipo de host: "windows" ou "mac"
creationDateTimeDate ISO 8601Data e hora de criação da sessão. Sessão autônoma: data e hora da inicialização do aplicativo
stateTextEstado da sessão: "ativa", "adiada", "em espera"
IDTextUUID da sessão (mesmo valor que .id)
persistentIDTextSessões remotas: ID persistente da sessão
nota

Since .info is a computed property, it is recommended to call it once and then to store it in a local variable if you want to do some processing on its properties.

.isGuest()

História
ReleaseMudanças
18 R6Adicionado

.isGuest() : Boolean

ParâmetroTipoDescrição
ResultadosParâmetros<-True se a sessão for uma sessão Guest, False caso contrário

Descrição

nota

Essa função sempre retorna False com cliente remoto, procedimento armazenado e sessões autônomas.

The .isGuest() function returns True if the session is a Guest session (i.e. it has no privileges).

Exemplo

No método base On Web Connection:

If (Session.isGuest())
//Do something for Guest user
End if

.restore()

História
ReleaseMudanças
20 R9Adicionado

.restore ( token : Text ) : Boolean

ParâmetroTipoDescrição
tokenText->UUID do token de sessão
ResultadosParâmetros<-True if the current session has been successfully replaced by the session in token

Descrição

nota

Essa função só está disponível com sessões de usuário Web. It returns False in other contexts.

A função .restore() substitui a sessão do usuário da web pela sua sessão original correspondente ao token UUID. Session's storage and privileges are restored.

If the original user session has been correctly restored, the function returns true.

A função retorna false se:

  • the session token has already been used,
  • the session token has expired,
  • the session token does not exist,
  • the original session itself has expired.

In this case, the current web user session is left untouched (no session is restored).

Exemplo

In a singleton called by a custom HTTP Request handler:

shared singleton Class constructor()

Function callback($request : 4D.IncomingMessage) : 4D.OutgoingMessage
Session.restore($request.urlQuery.state)

Veja também

.createOTP()

.setPrivileges()

História
ReleaseMudanças
19 R8Suporte da propriedade "roles" das Settings
18 R6Adicionado

.setPrivileges( privilege : Text ) : Boolean
.setPrivileges( privileges : Collection )
.setPrivileges( settings : Object ) : Boolean

ParâmetroTipoDescrição
privilegeText->Nome do privilégio
privilegesCollection->Collection de nomes de privilégios
settingsObject->Objetos com as propriedades "privilégios" (string ou collection)
ResultadosParâmetros<-True se a execução for bem-sucedida

Descrição

nota

Essa função não faz nada e sempre retorna False com cliente remoto, procedimento armazenado e sessões autônomas.

A função .setPrivileges() associa os privilégios e/ou papéis definidos no parâmetro para a sessão e retorna True se a execução foi bem sucedida .

  • No parâmetro privilege, passe uma cadeia de caracteres contendo um nome de privilégio (ou vários nomes de privilégio separados por vírgula).

  • No parâmetro privileges, passe uma coleção de cadeias de caracteres contendo nomes de privilégios.

  • No parâmetro settings, passe um objeto que contenha as seguintes propriedades:

PropriedadeTipoDescrição
privilegesText ou Collection
  • String containing a privilege name, or
  • Collection of strings containing privilege names
  • rolesText ou Collection
  • String containing a role, or
  • Collection of strings containing roles
  • userNameTextNome de usuário associado à sessão (opcional)
    nota

    Os privilégios e as funções são definidos no arquivo roles.json do projeto. Para obter mais informações, consulte a seção Privilégios.

    Se a propriedade privileges ou roles tiverem um nome que não seja declarado no arquivo roles.json, ele será ignorado.

    Como padrão quando não houver um privilégio associado à sessão, a sessão é uma Sessão de convidados.

    A propriedade userName está disponível no nível do objeto de sessão (somente leitura).

    Exemplo

    Em um método de autenticação personalizado, deve estabecer o privilégio "WebAdmin" ao usuário:

    var $userOK : Boolean

    ... //Autenticar o usuário

    If ($userOK) //O usuário foi aprovado
    var $info : Object
    $info:=New object()
    $info.privileges:=New collection("WebAdmin")
    Session.setPrivileges($info)
    End if

    Veja também

    .getPrivileges()

    .storage

    História
    ReleaseMudanças
    20 R5Support of remote client and stored procedure sessions
    18 R6Adicionado

    .storage : Object

    Descrição

    A propriedade .storage contém um objeto compartilhado que pode ser usado para armazenar informações disponíveis para todos os processos da sessão.

    Quando um objeto Session é criado, a propriedade .storage está vazia. Since it is a shared object, this property will be available in the Storage object of the server.

    Como o objeto Storage do servidor, a propriedade .storage é sempre "single": adicionar um objeto compartilhado ou uma coleção compartilhada a .storage não cria um grupo compartilhado.

    Essa propriedade é apenas de leitura, mas retorna um objeto de leitura e gravação.

    tip

    Você pode obter a propriedade .storage de uma sessão usando o comando Session storage.

    Exemplo de sessão na web

    Você deseja armazenar o IP do cliente na propriedade .storage. Você pode escrever no método de banco de dados On Web Authentication:

    If (Session.storage.clientIP=Null) //first access
    Use (Session.storage)
    Session.storage.clientIP:=New shared object("value"; $clientIP)
    End use End if

    Exemplo de sessão remota

    Você deseja compartilhar dados entre processos na mesma sessão:

    Use (Session.storage)
    Session.storage.settings:=New shared object("property"; $value; "property2"; $value2)
    End use

    .userName

    História
    ReleaseMudanças
    20 R5Support of remote client and stored procedure sessions
    18 R6Adicionado

    .userName : Text

    Descrição

    A propriedade .userName contém o nome de usuário associado à sessão. Pode usá-la para identificar o usuário dentro de seu código.

    • Com sessões da Web, essa propriedade é uma cadeia de caracteres vazia por padrão. Ele pode ser definido usando a propriedade privileges da função setPrivileges().
    • Com sessões de procedimento remotas e armazenadas, esta propriedade retorna o mesmo nome de usuário que o comando Current user.
    • Com sessões autônomas, essa propriedade contém "designer" ou o nome definido com o comando SET USER ALIAS.

    Essa propriedade é somente leitura.