Managed Object - SessionManager

Property of
ServiceContent
See also
SessionManagerLocalTicket, UserSession

Managed Object Description

This managed object type includes methods for logging on and logging off clients, determining which clients are currently logged on, and forcing clients to log off.

Properties

Name Type Description
currentSession* PUserSession This property contains information about the client's current session. If the client is not logged on, the value is null.
defaultLocale Pxsd:string This is the default server locale.
message* Pxsd:string The system global message from the server.
messageLocaleList* Pxsd:string[] Provides the list of locales for which the server has localized messages.
sessionList* PUserSession[] The list of currently active sessions.
supportedLocaleList* Pxsd:string[] Provides the list of locales that the server supports. Listing a locale ensures that some standardized information such as dates appear in the appropriate format. Other localized information, such as error messages, are displayed, if available. If localized information is not available, the message is returned using the system locale.
*May not be presentPRequired privilege - see tooltip for details

Methods

Methods defined in this Managed Object
AcquireLocalTicket, Login, Logout, SetLocale, TerminateSession, UpdateServiceMessage

AcquireLocalTicket

Acquires a one-time ticket for mutual authentication between a server and client.

The caller of this operation can use the user name and file content of the returned object as the userName and password arguments for login operation. The local ticket that is returned becomes invalid either after it is used or after a server-determined ticket expiration time passes. This operation can be used by servers and clients to avoid re-entering user credentials after authentication by the operating system has already happened.

For example, service console utilities that connect to a host agent should not require users to re-enter their passwords every time the utilities run. Since the one-time password file is readable only by the given user, the identity of the one-time password user is protected by the operating system file permission.

Only local clients are allowed to call this operation. Remote clients receive an InvalidRequest fault upon calling this operation.

Required Privileges
System.Anonymous

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SessionManager used to make the method call.
userNamexsd:string User requesting one-time password.

Return Value

Type Description
SessionManagerLocalTicketLocalTicket object containing userName and path to file containing one-time password for use in login operation.

Faults

Type Description
InvalidLoginThrown if the userName is invalid.
NoPermissionThrown if the user and password are valid, but the user has no access granted.
NotSupportedThrown if the server does not support this operation.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



Login

Log on to the server. This method fails if the user name and password are incorrect, or if the user is valid but has no permissions granted.
Required Privileges
System.Anonymous

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SessionManager used to make the method call.
userNamexsd:string The ID of the user who is logging on to the server.
passwordxsd:string The password of the user who is logging on to the server.
locale*xsd:string A two-character ISO-639 language ID (like "en") optionally followed by an underscore and a two-character ISO 3166 country ID (like "US").

Examples are "de", "fr_CA", "zh", "zh_CN", and "zh_TW". Note: The method uses the server default locale when a locale is not provided. This default can be configured in the server configuration file. If unspecified, it defaults to the locale of the server environment or English ("en") if unsupported.

*Need not be set

Return Value

Type Description
UserSessionThe UserSession object.

Faults

Type Description
InvalidLocaleThrown if the locale is invalid or unknown to the server.
InvalidLoginThrown if the user and password combination is invalid.
NoPermissionThrown if the user is valid, but has no access granted.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



Logout

Log out and terminate the current session.
Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SessionManager used to make the method call.

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



SetLocale

Sets the session locale.
Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SessionManager used to make the method call.
localexsd:string A two-character ISO-639 language ID (like "en") optionally followed by an underscore and a two-character ISO 3166 country ID (like "US").

Examples are "de", "fr_CA", "zh", "zh_CN", and "zh_TW". Note: The method uses the server default locale when a locale is not provided. This default can be configured in the server configuration file. If unspecified, it defaults to the locale of the server environment or English ("en") if unsupported.


Return Value

Type Description
None

Faults

Type Description
InvalidLocaleThrown if the locale is invalid or unknown to the server.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



TerminateSession

Log off and terminate the provided list of sessions.

This method is only transactional for each session ID. The set of sessions are terminated sequentially, as specified in the list. If a failure occurs, for example, because of an unknown sessionID, the method aborts with an exception. When the method aborts, any sessions that have not yet been terminated are left in their unterminated state.

Required Privileges
Sessions.TerminateSession

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SessionManager used to make the method call.
sessionIdxsd:string[] A list of sessions to terminate.

Return Value

Type Description
None

Faults

Type Description
InvalidArgumentThrown if a sessionId matches the current session. Use the logout method to terminate the current session.
NotFoundThrown if a sessionId could not be found as a valid logged-on session.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



UpdateServiceMessage

Updates the system global message. If not blank, the message is immediately displayed to currently logged-on users. When set, the message is shown by new clients upon logging in.
Required Privileges
Sessions.GlobalMessage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SessionManager used to make the method call.
messagexsd:string The message to send. Newline characters may be included.

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition