Managed Object - ConverterAgentSessionManager

Extends
ConverterSessionManager
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
pid Pxsd:int

This is the process Id of the Agent process. It will be used to pass a local Windows user token from the caller.
Properties inherited from ConverterSessionManager
currentSession, defaultLocale, messageLocaleList, sessionList, supportedLocaleList
P Required privilege: System.Anonymous

Methods

Methods defined in this Managed Object
ConverterAgentImpersonateUser, ConverterAgentLoginWithCertificate, ConverterAgentRegister, ConverterAgentUnregister
Methods inherited from ConverterSessionManager
ConverterImpersonate, ConverterLogin, ConverterLoginExtension, ConverterLoginSession, ConverterLogout, ConverterSetLocale, ConverterTerminateSession

ConverterAgentImpersonateUser

Log on to the server and impersonate a logged in interactive user. This method assumes that connection to the server was established over a transport which supports transferring user credentials over the wire (for example, the Windows named pipes). The credentials in the pipe is used to verify if the caller is a privileged user. In addition, this method is used to set the client Token handle. This method fails if the user cannot be impersonated.
Required Privileges
System.Anonymous

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterAgentSessionManager used to make the method call.
userName Pxsd:string

Since Converter API 1.0
token Pxsd:long

specifies the client token that will be used to impersonate session.

Since Converter API 1.0
locale* Pxsd:string

A two-character ISO-639 language ID (like "en")

Since Converter API 1.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ConverterUserSession

Faults

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

Events

Type
None



ConverterAgentLoginWithCertificate

Login using SSL certificate. The caller must already be registered with the agent.
Required Privileges
System.Anonymous
Since
Converter API 2.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterAgentSessionManager used to make the method call.
locale* Pxsd:string

Since Converter API 2.0
*Need not be set P Required privilege: locale

Return Value

Type Description
ConverterUserSession

Faults

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

Events

Type
None



ConverterAgentRegister

Register caller's SSL certificate with the agent. The caller will be able to to use LoginWithCertificate following this call.
Required Privileges
None
Since
Converter API 2.0

Parameters

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

Return Value

Type Description
None

Faults

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

Events

Type
None



ConverterAgentUnregister

Unregister caller's certificate. The caller won't be able to login with certificate after this call.
Required Privileges
None
Since
Converter API 2.0

Parameters

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

Return Value

Type Description
None

Faults

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

Events

Type
None