com.vmware.cis

Class SessionStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.cis.SessionStub

All Implemented Interfaces:

Session, SessionTypes, Service

public class SessionStub
extends com.vmware.vapi.internal.bindings.Stub
implements Session

Remote stub implementation of the Session API service.

WARNING: Internal class, subject to change in future versions.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.cis.SessionTypes

SessionTypes.Info

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, securityContext

Fields inherited from interface com.vmware.cis.SessionTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
SessionStub(ApiProvider apiProvider, StubConfigurationBase config)
SessionStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

Method Summary

Modifier and Type	Method and Description
char[]	create() Creates a session with the API.
void	create(AsyncCallback<char[]> asyncCallback) Creates a session with the API.
void	create(AsyncCallback<char[]> asyncCallback, InvocationConfig invocationConfig) Creates a session with the API.
char[]	create(InvocationConfig invocationConfig) Creates a session with the API.
void	delete() Terminates the validity of a session token.
void	delete(AsyncCallback<java.lang.Void> asyncCallback) Terminates the validity of a session token.
void	delete(AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Terminates the validity of a session token.
void	delete(InvocationConfig invocationConfig) Terminates the validity of a session token.
SessionTypes.Info	get() Returns information about the current session.
void	get(AsyncCallback<SessionTypes.Info> asyncCallback) Returns information about the current session.
void	get(AsyncCallback<SessionTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about the current session.
SessionTypes.Info	get(InvocationConfig invocationConfig) Returns information about the current session.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SessionStub

public SessionStub(ApiProvider apiProvider,
                   com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                   StubConfigurationBase config)

SessionStub

public SessionStub(ApiProvider apiProvider,
                   StubConfigurationBase config)

Method Detail

create

public char[] create()

Description copied from interface: Session

Creates a session with the API. This is the equivalent of login. This method exchanges user credentials supplied in the security context for a session identifier that is to be used for authenticating subsequent calls. To authenticate subsequent calls clients are expected to include the session key.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

create in interface Session

Returns:

Newly created session identifier to be used for authenticating further requests.

create

public char[] create(InvocationConfig invocationConfig)

Description copied from interface: Session

Creates a session with the API. This is the equivalent of login. This method exchanges user credentials supplied in the security context for a session identifier that is to be used for authenticating subsequent calls. To authenticate subsequent calls clients are expected to include the session key.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

create in interface Session

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

Newly created session identifier to be used for authenticating further requests.

create

public void create(AsyncCallback<char[]> asyncCallback)

Description copied from interface: Session

Creates a session with the API. This is the equivalent of login. This method exchanges user credentials supplied in the security context for a session identifier that is to be used for authenticating subsequent calls. To authenticate subsequent calls clients are expected to include the session key.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
Newly created session identifier to be used for authenticating further requests.

Operation Errors:
Unauthenticated - if the session creation fails due to request specific issues. Due to the security nature of the API the details of the error are not disclosed.

Please check the following preconditions if using a SAML token to authenticate:

• the supplied token is delegate-able.
• the time of client and server system are synchronized.
• the token supplied is valid.
• if bearer tokens are used check that system configuration allows the API endpoint to accept such tokens.

ServiceUnavailable - if session creation fails due to server specific issues, for example connection to a back end component is failing. Due to the security nature of this API further details will not be disclosed in the exception. Please refer to component health information, administrative logs and product specific documentation for possible causes.

Specified by:

create in interface Session

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

create

public void create(AsyncCallback<char[]> asyncCallback,
                   InvocationConfig invocationConfig)

Description copied from interface: Session

Creates a session with the API. This is the equivalent of login. This method exchanges user credentials supplied in the security context for a session identifier that is to be used for authenticating subsequent calls. To authenticate subsequent calls clients are expected to include the session key.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
Newly created session identifier to be used for authenticating further requests.

Operation Errors:
Unauthenticated - if the session creation fails due to request specific issues. Due to the security nature of the API the details of the error are not disclosed.

Please check the following preconditions if using a SAML token to authenticate:

• the supplied token is delegate-able.
• the time of client and server system are synchronized.
• the token supplied is valid.
• if bearer tokens are used check that system configuration allows the API endpoint to accept such tokens.

ServiceUnavailable - if session creation fails due to server specific issues, for example connection to a back end component is failing. Due to the security nature of this API further details will not be disclosed in the exception. Please refer to component health information, administrative logs and product specific documentation for possible causes.

Specified by:

create in interface Session

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

delete

public void delete()

Description copied from interface: Session

Terminates the validity of a session token. This is the equivalent of log out.

A session identifier is expected as part of the request.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

delete in interface Session

delete

public void delete(InvocationConfig invocationConfig)

Description copied from interface: Session

Terminates the validity of a session token. This is the equivalent of log out.

A session identifier is expected as part of the request.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

delete in interface Session

Parameters:

invocationConfig - Configuration for the method invocation.

delete

public void delete(AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Session

Terminates the validity of a session token. This is the equivalent of log out.

A session identifier is expected as part of the request.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Unauthenticated - if the session id is missing from the request or the corresponding session object cannot be found.
ServiceUnavailable - if session deletion fails due to server specific issues, for example connection to a back end component is failing. Due to the security nature of this API further details will not be disclosed in the exception. Please refer to component health information, administrative logs and product specific documentation for possible causes.

Specified by:

delete in interface Session

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

delete

public void delete(AsyncCallback<java.lang.Void> asyncCallback,
                   InvocationConfig invocationConfig)

Description copied from interface: Session

Terminates the validity of a session token. This is the equivalent of log out.

A session identifier is expected as part of the request.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Unauthenticated - if the session id is missing from the request or the corresponding session object cannot be found.
ServiceUnavailable - if session deletion fails due to server specific issues, for example connection to a back end component is failing. Due to the security nature of this API further details will not be disclosed in the exception. Please refer to component health information, administrative logs and product specific documentation for possible causes.

Specified by:

delete in interface Session

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

get

public SessionTypes.Info get()

Description copied from interface: Session

Returns information about the current session. This method expects a valid session identifier to be supplied.

A side effect of invoking this method may be a change to the session's last accessed time to the current time if this is supported by the session implementation. Invoking any other method in the API will also update the session's last accessed time.

This API is meant to serve the needs of various front end projects that may want to display the name of the user. Examples of this include various web based user interfaces and logging facilities.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

get in interface Session

Returns:

Information about the session.

get

public SessionTypes.Info get(InvocationConfig invocationConfig)

Description copied from interface: Session

Returns information about the current session. This method expects a valid session identifier to be supplied.

A side effect of invoking this method may be a change to the session's last accessed time to the current time if this is supported by the session implementation. Invoking any other method in the API will also update the session's last accessed time.

This API is meant to serve the needs of various front end projects that may want to display the name of the user. Examples of this include various web based user interfaces and logging facilities.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

get in interface Session

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

Information about the session.

get

public void get(AsyncCallback<SessionTypes.Info> asyncCallback)

Description copied from interface: Session

Returns information about the current session. This method expects a valid session identifier to be supplied.

A side effect of invoking this method may be a change to the session's last accessed time to the current time if this is supported by the session implementation. Invoking any other method in the API will also update the session's last accessed time.

This API is meant to serve the needs of various front end projects that may want to display the name of the user. Examples of this include various web based user interfaces and logging facilities.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
Information about the session.

Operation Errors:
Unauthenticated - if the session id is missing from the request or the corresponding session object cannot be found.
ServiceUnavailable - if session retrieval fails due to server specific issues e.g. connection to back end component is failing. Due to the security nature of this API further details will not be disclosed in the error. Please refer to component health information, administrative logs and product specific documentation for possible causes.

Specified by:

get in interface Session

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

public void get(AsyncCallback<SessionTypes.Info> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Session

Returns information about the current session. This method expects a valid session identifier to be supplied.

A side effect of invoking this method may be a change to the session's last accessed time to the current time if this is supported by the session implementation. Invoking any other method in the API will also update the session's last accessed time.

This API is meant to serve the needs of various front end projects that may want to display the name of the user. Examples of this include various web based user interfaces and logging facilities.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
Information about the session.

Operation Errors:
Unauthenticated - if the session id is missing from the request or the corresponding session object cannot be found.
ServiceUnavailable - if session retrieval fails due to server specific issues e.g. connection to back end component is failing. Due to the security nature of this API further details will not be disclosed in the error. Please refer to component health information, administrative logs and product specific documentation for possible causes.

Specified by:

get in interface Session

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.