oracle.ifs.fdk
Interface LoginManager

public interface LoginManager

The session manager interface allows applications to create and dispose user sessions.

(Unpublished)

Field Summary

static java.lang.String	LOGIN_OPTION_APPLICATION_NAME The option representing the name of the application requesting a login.
static java.lang.String	LOGIN_OPTION_SSO_REALM_GUID The SSO/OID realm GUID option (only if SSO is enabled).
static java.lang.String	LOGIN_OPTION_SSO_USER_GUID The SSO/OID user GUID login option (only if SSO is enabled).
static java.lang.String	OPTION_NAMESPACE

Method Summary

java.lang.String	getServerVersionNumberString() Gets the server version number string.
FdkSession	login(oracle.ifs.common.Credential credential, java.util.Map options) Returns a connected session given the user's credentials.
void	logout(FdkSession session) Disconnects a session obtained via the session manager.

Field Detail

LOGIN_OPTION_APPLICATION_NAME

public static final java.lang.String LOGIN_OPTION_APPLICATION_NAME

The option representing the name of the application requesting a login. The value of the option is a string such as "FTP", "DAV", etc.

LOGIN_OPTION_SSO_REALM_GUID

public static final java.lang.String LOGIN_OPTION_SSO_REALM_GUID

The SSO/OID realm GUID option (only if SSO is enabled).

LOGIN_OPTION_SSO_USER_GUID

public static final java.lang.String LOGIN_OPTION_SSO_USER_GUID

The SSO/OID user GUID login option (only if SSO is enabled).

OPTION_NAMESPACE

public static final java.lang.String OPTION_NAMESPACE

Method Detail

getServerVersionNumberString

public java.lang.String getServerVersionNumberString()

Gets the server version number string.

Returns:

a string representing the server version number

Throws:

FdkException - conceivably

login

public FdkSession login(oracle.ifs.common.Credential credential,
                        java.util.Map options)
                 throws FdkException

Returns a connected session given the user's credentials. Sessions obtained via the session manager must be disconnected by calling the session manager's logout method.

Parameters:

credential - The user credential.

options - The options used to connect. Can be null. The name of the options are defined in this interface.

Throws:

FdkException

logout

public void logout(FdkSession session)
            throws FdkException

Disconnects a session obtained via the session manager. An exception is raised if the session was not obtained via this session manager.

Parameters:

session - The session to disconnect.

Throws:

FdkException