com.crystaldecisions.sdk.occa.security
Interface ILogonTokenMgr


public interface ILogonTokenMgr

This object manages the creation and release of logon tokens for logged on users. This enables the user to access multiple reports and pages without having to log on again with a user name and password.


Method Summary
 java.lang.String createLogonToken(java.lang.String clientComputerName, int validMinutes, int validNumOfLogons)
           Creates a logon token that can be used for multiple logons.
 java.lang.String createWCAToken(java.lang.String clientComputerName, int validMinutes, int validNumOfLogons)
           Creates a logon token that can be used for multiple logons without increasing the session count.
 java.lang.String getDefaultToken()
           Gets the default session logon token.
 void releaseToken(java.lang.String InToken)
           Releases the token when it will no longer be used.
 

Method Detail

createLogonToken

public java.lang.String createLogonToken(java.lang.String clientComputerName,
                                         int validMinutes,
                                         int validNumOfLogons)
                                  throws SDKException

Creates a logon token that can be used for multiple logons. Specify the client computer name where you want to use the token, the number of minutes it will be valid, and the maximum number of logons. Tokens created with this method should be released with releaseToken if possible.

Parameters:
clientComputerName - The name of the client computer that will use the token. An empty string means that the token can be used from any client computer.
validMinutes - The number of minutes that the token will be valid for.
validNumOfLogons - The number of logons that the token can be used for.
Returns:
A String containing the newly created token.
Throws:
SDKException - This is thrown if the process is unsuccessful.

createWCAToken

public java.lang.String createWCAToken(java.lang.String clientComputerName,
                                       int validMinutes,
                                       int validNumOfLogons)
                                throws SDKException

Creates a logon token that can be used for multiple logons without increasing the session count. Specify the client computer name where you want to use the token, the number of minutes it will be valid, and the maximum number of logons. Tokens created with this method should be released with releaseToken if possible.

Parameters:
clientComputerName - The name of the client computer that will use the token. An empty string means that the token can be used from any client computer.
validMinutes - The number of minutes that the token will be valid for.
validNumOfLogons - The number of logons that the token can be used for.
Returns:
A String containing the newly created token.
Throws:
SDKException - This is thrown if the process is unsuccessful.

getDefaultToken

public java.lang.String getDefaultToken()
                                 throws SDKException

Gets the default session logon token. This token should not be manually released.

Returns:
A String containing the default session logon token.
Throws:
SDKException - This is thrown if the process is unsuccessful.

releaseToken

public void releaseToken(java.lang.String InToken)
                  throws SDKException

Releases the token when it will no longer be used.

Parameters:
InToken - The token to be released.
Throws:
SDKException - This is thrown if the process is unsuccessful.