com.vmware.vim25.mo

Class SessionManager

java.lang.Object

com.vmware.vim25.mo.ManagedObject

com.vmware.vim25.mo.SessionManager

public class SessionManager
extends ManagedObject

The managed object class corresponding to the one defined in VI SDK API reference.

Author:

Steve JIN (http://www.doublecloud.org)

Constructor Summary

Constructors

Constructor and Description
SessionManager(ServerConnection serverConnection, ManagedObjectReference mor)

Method Summary

Methods

Modifier and Type	Method and Description
String	acquireCloneTicket()
SessionManagerGenericServiceTicket	acquireGenericServiceTicket(SessionManagerServiceRequestSpec spec)
SessionManagerLocalTicket	acquireLocalTicket(String userName)
ServiceInstance	cloneSession(boolean ignoreCert) Copyright 2009 NetApp, contribution by Eric Forgette Modified by Steve Jin (sjin@vmware.com) This constructor builds a new ServiceInstance based on a ServiceInstance.
UserSession	cloneSession(String cloneTicket)
UserSession	getCurrentSession()
String	getDefaultLocale()
String	getMessage()
String[]	getMessageLocaleList()
UserSession[]	getSessionList()
String[]	getSupportedLocaleList()
UserSession	impersonateUser(String userName, String locale)
UserSession	login(String userName, String password, String locale)
UserSession	loginBySSPI(String base64Token, String locale)
UserSession	loginByToken(String locale)
UserSession	loginExtensionByCertificate(String extensionKey, String locale)
UserSession	loginExtensionBySubjectName(String extensionKey, String locale)
void	logout()
boolean	sessionIsActive(String sessionID, String userName)
void	setLocale(String locale)
void	terminateSession(String[] sessionIDs)
void	updateServiceMessage(String message)

Methods inherited from class com.vmware.vim25.mo.ManagedObject

convertMors, getCurrentProperty, getDatastores, getFilter, getHosts, getManagedObject, getManagedObjects, getManagedObjects, getMOR, getNetworks, getPropertiesByPaths, getPropertyByPath, getResourcePools, getScheduledTasks, getServerConnection, getTasks, getViews, getVimService, getVms, retrieveObjectProperties, setMOR, setServerConnection, toString, waitForValues

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionManager

public SessionManager(ServerConnection serverConnection,
              ManagedObjectReference mor)

Method Detail

getCurrentSession

public UserSession getCurrentSession()

getDefaultLocale

public String getDefaultLocale()

getMessage

public String getMessage()

getMessageLocaleList

public String[] getMessageLocaleList()

getSessionList

public UserSession[] getSessionList()

getSupportedLocaleList

public String[] getSupportedLocaleList()

acquireLocalTicket

public SessionManagerLocalTicket acquireLocalTicket(String userName)
                                             throws InvalidLogin,
                                                    RuntimeFault,
                                                    RemoteException

Throws:

InvalidLogin

RuntimeFault

RemoteException

acquireGenericServiceTicket

public SessionManagerGenericServiceTicket acquireGenericServiceTicket(SessionManagerServiceRequestSpec spec)
                                                               throws RuntimeFault,
                                                                      RemoteException

Throws:

RuntimeFault

RemoteException

Since:

SDK5.0

cloneSession

public UserSession cloneSession(String cloneTicket)
                         throws InvalidLogin,
                                RuntimeFault,
                                RemoteException

Throws:

InvalidLogin

RuntimeFault

RemoteException

Since:

SDK4.0 You don't need to use this method. Instead, look at the other cloneSession method.

cloneSession

public ServiceInstance cloneSession(boolean ignoreCert)
                             throws InvalidLogin,
                                    RuntimeFault,
                                    RemoteException,
                                    MalformedURLException

Copyright 2009 NetApp, contribution by Eric Forgette Modified by Steve Jin (sjin@vmware.com) This constructor builds a new ServiceInstance based on a ServiceInstance. The new ServiceInstance is effectively a clone of the first. This clone will NOT become invalid when the first is logged out.

Throws:

RemoteException

RuntimeFault

InvalidLogin

MalformedURLException

acquireCloneTicket

public String acquireCloneTicket()
                          throws RuntimeFault,
                                 RemoteException

Throws:

RuntimeFault

RemoteException

Since:

SDK4.0 This method is called in the cloneSession method. If you happen to use this method, please double check if it's really needed.

loginExtensionBySubjectName

public UserSession loginExtensionBySubjectName(String extensionKey,
                                      String locale)
                                        throws InvalidLogin,
                                               InvalidLocale,
                                               NotFound,
                                               NoClientCertificate,
                                               NoSubjectName,
                                               RuntimeFault,
                                               RemoteException

Throws:

InvalidLogin

InvalidLocale

NotFound

NoClientCertificate

NoSubjectName

RuntimeFault

RemoteException

Since:

SDK4.0

loginExtensionByCertificate

public UserSession loginExtensionByCertificate(String extensionKey,
                                      String locale)
                                        throws InvalidLogin,
                                               InvalidLocale,
                                               NoClientCertificate,
                                               RuntimeFault,
                                               RemoteException

Throws:

InvalidLogin

InvalidLocale

NoClientCertificate

RuntimeFault

RemoteException

Since:

SDK4.0

impersonateUser

public UserSession impersonateUser(String userName,
                          String locale)
                            throws InvalidLogin,
                                   InvalidLocale,
                                   RuntimeFault,
                                   RemoteException

Throws:

InvalidLogin

InvalidLocale

RuntimeFault

RemoteException

login

public UserSession login(String userName,
                String password,
                String locale)
                  throws InvalidLogin,
                         InvalidLocale,
                         RuntimeFault,
                         RemoteException

Throws:

InvalidLogin

InvalidLocale

RuntimeFault

RemoteException

loginBySSPI

public UserSession loginBySSPI(String base64Token,
                      String locale)
                        throws InvalidLogin,
                               InvalidLocale,
                               SSPIChallenge,
                               RuntimeFault,
                               RemoteException

Throws:

InvalidLogin

InvalidLocale

SSPIChallenge

RuntimeFault

RemoteException

loginByToken

public UserSession loginByToken(String locale)
                         throws InvalidLogin,
                                InvalidLocale,
                                RuntimeFault,
                                RemoteException

Throws:

InvalidLogin

InvalidLocale

RuntimeFault

RemoteException

Since:

SDK5.1

logout

public void logout()
            throws RuntimeFault,
                   RemoteException

Throws:

RuntimeFault

RemoteException

sessionIsActive

public boolean sessionIsActive(String sessionID,
                      String userName)
                        throws RuntimeFault,
                               RemoteException

Throws:

RuntimeFault

RemoteException

setLocale

public void setLocale(String locale)
               throws InvalidLocale,
                      RuntimeFault,
                      RemoteException

Throws:

InvalidLocale

RuntimeFault

RemoteException

terminateSession

public void terminateSession(String[] sessionIDs)
                      throws NotFound,
                             RuntimeFault,
                             RemoteException

Throws:

NotFound

RuntimeFault

RemoteException

updateServiceMessage

public void updateServiceMessage(String message)
                          throws RuntimeFault,
                                 RemoteException

Throws:

RuntimeFault

RemoteException