com.orchestranetworks.service
Interface Session

public interface Session

Represents a user session, either a HTTP session or a "programmatic" session.

When running in EBX.Manager, HTTP session is obtained by calling methods:

• ServiceContext.getSession()
• UIContext.getSession()
• UILabelRendererContext.getSession()

Outside EBX.Manager, a session is obtained by calling methods:

• Repository.createSessionFromLoginPassword(String, String),
• Repository.createSessionFromHttpRequest(HttpServletRequest).
• Repository.createSessionFromArray(Object[]).

Method Summary

Object	getAttribute(String aName) Returns the object bound with the specified name in this session, or null if no object is bound under the name.
Set	getAttributeNames() Returns a Set of String objects containing the names of all the objects bound to this session.
String	getHttpSessionId() If known, returns a string containing the unique identifier assigned to the current HTTP session.
String	getIpAddress() If known, returns the Internet Protocol (IP) address of the client that sent the request.
Locale	getLocale() Returns the session's current locale.
Locale	getLocaleForSchemaNode(SchemaNode schemaNode) Returns the user's preferred locale associated with the underlying schema of the specified node.
SessionPermissions	getPermissions() Returns the current user's permissions facade.
String	getTrackingInfo() If specified, returns tracking information.
String	getUserEmail() Returns the user email address.
String	getUserLogin() Deprecated. Replaced by getUserReference().
UserReference	getUserReference() Returns the user reference in the directory.
boolean	isUserInRole(Profile aProfile) Returns true if this user or the session has the specified profile.
boolean	isUserOwner(Adaptation anAdaptation) Returns true if this user is an owner of the adaptation specified.
void	setAttribute(String aName, Object aValue) Binds an object to this session, using the name specified.

Method Detail

getIpAddress

public String getIpAddress()

If known, returns the Internet Protocol (IP) address of the client that sent the request. This is same as the value of the CGI variable REMOTE_ADDR.

getHttpSessionId

public String getHttpSessionId()

If known, returns a string containing the unique identifier assigned to the current HTTP session. The identifier is assigned by the servlet container and depends on its implementation.

getLocale

public Locale getLocale()

Returns the session's current locale.

It is searched in the following order:

1. the locale attached to the Manager session (if session has been created in this context)
2. the default product locale.

See Also:

getLocaleForSchemaNode(SchemaNode)

getLocaleForSchemaNode

public Locale getLocaleForSchemaNode(SchemaNode schemaNode)

Returns the user's preferred locale associated with the underlying schema of the specified node. This method is useful when schema supports some locales that are not supported by product.

It returns either:

• the user's preferred locale for the specified schema, if defined;
• the result of getLocale(), otherwise.

For more information on where additional locales are declared, read Module Declaration.

getTrackingInfo

public String getTrackingInfo()

If specified, returns tracking information. It may be for example:

• a task description if user has been assigned a particular task;
• a project name if he is working in the context of a project.

Tracking info is logged into EBX.Platform 'history' logs. It may also be used for any other purpose like access control or additional export information.

Note: there are three ways to specify tracking info:

• In the context of calling EBX.Manager through a HTTP request, tracking info is specified via method UIHttpManagerComponent.setTrackingInfo(String).
• In the context of a programmatic service, tracking info is specified via method ProgrammaticService.setSessionTrackingInfo(String).
• In the context of a Data Service.

See Also:

ProcedureContext.setExecutionInformation(String)

getUserLogin

public String getUserLogin()

Deprecated. Replaced by getUserReference().

getUserReference

public UserReference getUserReference()

Returns the user reference in the directory.

getUserEmail

public String getUserEmail()

Returns the user email address.

getPermissions

public SessionPermissions getPermissions()

Returns the current user's permissions facade. It allows to ckeck user's permissions on branches, adaptations and nodes (tables, ...).

isUserInRole

public boolean isUserInRole(Profile aProfile)

Returns true if this user or the session has the specified profile. If the specified profile is a role, this means that the user is in the specified role. If it is a UserReference, this means that the current session user has this reference.

isUserOwner

public boolean isUserOwner(Adaptation anAdaptation)

Returns true if this user is an owner of the adaptation specified.

Unless specified otherwise in a permission rule, a user that owns an adaptation has no access restrictions onto it.

getAttribute

public Object getAttribute(String aName)

Returns the object bound with the specified name in this session, or null if no object is bound under the name.

Parameters:

aName - a string specifying the name of the object

Returns:

the object with the specified name

getAttributeNames

public Set getAttributeNames()

Returns a Set of String objects containing the names of all the objects bound to this session.

Returns:

an unmodifiable Set of String objects specifying the names of all the objects bound to this session

setAttribute

public void setAttribute(String aName,
                         Object aValue)

Binds an object to this session, using the name specified. If an object of the same name is already bound to the session, the object is replaced.

If the value passed in is null, this removes the object bound.

Parameters:

aName - the name to which the object is bound

aValue - the object to be bound

Throws:

IllegalArgumentException - if aName is null