# Managed Object - ConverterSessionManager

Property of
  ConverterServiceContent
Extended by
  ConverterAgentSessionManager
See also
  ConverterUserSession
Since
  Converter API 1.0

## Managed Object Description

This managed object type includes methods for logging on and logging off clients.

Properties

Name | Type | Description
--- | --- | ---
currentSession* | ConverterUserSession | This property contains information about the client's current session. If the client is not logged on, the value is null.
defaultLocale P | xsd:string | This is the default server locale.
messageLocaleList* P | xsd:string[] | Provides the list of locales for which the server has localized messages.
sessionList* P | ConverterUserSession[] | The list of currently active sessions.
supportedLocaleList* P | xsd: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 present P Required privilege - see tooltip for details

Methods

Methods defined in this Managed Object
ConverterImpersonate, ConverterLogin, ConverterLoginExtension, ConverterLoginSession, ConverterLogout, ConverterSetLocale, ConverterTerminateSession

# ConverterImpersonate

Impersonate client. This method only works if the call is made over a pipe and fails if the user has no permissions granted.

Required Privileges
  System.Anonymous

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterSessionManager used to make the method call.
locale* P | 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. Since Converter API 1.0

*Need not be set P Required privilege: locale

Return Value

Type | Description
--- | ---
ConverterUserSession | The UserSession object.

Faults

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

Events

Type
None

# ConverterLogin

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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterSessionManager used to make the method call.
userName P | xsd:string | The name of the user who is logging on to the server. Since Converter API 1.0
password P | xsd:string | The password of the user who is logging on to the server. Since Converter API 1.0
locale* P | 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. Since Converter API 1.0

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ConverterUserSession | The UserSession object.

Faults

Type | Description
--- | ---
InvalidLocale | Thrown if the locale is invalid or unknown to the server.
InvalidLogin | Thrown if the user and password combination is invalid.
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

# ConverterLoginExtension

Log on to the extension 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterSessionManager used to make the method call.
userName P | xsd:string | The name of the VC user who is logging on to the server. Since Converter API 1.0
password P | xsd:string | The password of the user on VC. Since Converter API 1.0
locale* P | 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"). Since Converter API 1.0

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ConverterUserSession | The UserSession object.

Faults

Type | Description
--- | ---
InvalidLocale | Thrown if the locale is invalid or unknown to the server.
InvalidLogin | Thrown if the user and sessionId combination is invalid.
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

# ConverterLoginSession

Log on to the extension server. This method fails if the user name and session ID are incorrect, or if the user is valid but has no permissions granted.

Required Privileges
  System.Anonymous

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterSessionManager used to make the method call.
userName P | xsd:string | The name of the VC user who is logging on to the server. Since Converter API 1.0
sessionId P | xsd:string | The session ID of the user's active VC session. Since Converter API 1.0
locale* P | 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"). Since Converter API 1.0

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ConverterUserSession | The UserSession object.

Faults

Type | Description
--- | ---
InvalidLocale | Thrown if the locale is invalid or unknown to the server.
InvalidLogin | Thrown if the user and sessionId combination is invalid.
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

# ConverterLogout

Log out and terminate the current session.

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterSessionManager used to make the method call.

Return Value

Type | Description
--- | ---
None

Faults

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

Events

Type
None

# ConverterSetLocale

Sets the session locale.

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterSessionManager used to make the method call.
locale P | 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. Since Converter API 1.0

P Required privilege: locale

Return Value

Type | Description
--- | ---
None

Faults

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

Events

Type
None

# ConverterTerminateSession

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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterSessionManager used to make the method call.
sessionId P | xsd:string[] | A list of sessions to terminate. Since Converter API 1.0

P Required privilege: sessionId

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
NotFound | Thrown if a sessionId could not be found as a valid logged-on session.
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None