com.sap.portal.httpconnectivity.httpauthentication.engine

Interface IAuthMethodInformation

public interface IAuthMethodInformation

This Interface includs all the methids to connect to a certain system and to obtain it's properties.

Method Summary

Modifier and Type	Method and Description
String	getAlias() Gets the system alias
String	GetAuthenticationAssistantType() Specifies if the authentication is done on the server or on the client side
String	getAuthenticationURL() Specifies the URL which the authentication assistant must use to authenticate the portal for the current system
int	getAutoCloseTimeout() gets the automatic time to close window when using client auth.
String	GetCustomServiceID() Specifies the unique name of a portal service used by the current system that implements a customized authentication method.
String	getMapPassword() Gets the mapped password of the system.
String	getMapUser() Gets the mapped user of the system.
String	getMethodParameterID() Specifies how the client's browser or the server sends the authentication information to the back-end system
String	getMethodProperty(String attributeID) Gets a method property
String	getPasswordParameterID() The parameter ID that specifies the password of the user in the authentication URL.
String	getSystemProperty(String propertyID) Gets a system property.
String	getUserParameterID() The parameter ID that specifies the name of the user in the authentication URL.
String	IsAuthenticationAssistantActivated() Allows the user to enable or disable the authentication assistant process for portal components based on the current system.
String	IsPermanentAuth() Choosing the enable option makes the authentication on the client side occur every time an iView\ portal component is loaded.

Method Detail

getSystemProperty

String getSystemProperty(String propertyID)
                  throws Exception

Gets a system property.

Parameters:

propertyID - The ID of the property

Returns:

the property value

Throws:

Exception - An exception including the suitible HTTP Authentication error message.

getMethodProperty

String getMethodProperty(String attributeID)
                  throws Exception

Gets a method property

Parameters:

attributeID - attribute ID

Returns:

The property value

Throws:

Exception - An exception including the suitible HTTP Authentication error message.

getAlias

String getAlias()

Gets the system alias

Returns:

the system alias name

getMapUser

String getMapUser()
           throws Exception

Gets the mapped user of the system.

Returns:

The mapped user name

Throws:

Exception - An exception including the suitible HTTP Authentication error message.

getMapPassword

String getMapPassword()
               throws Exception

Gets the mapped password of the system.

Returns:

The mapped password name

Throws:

Exception - An exception including the suitible HTTP Authentication error message.

getAutoCloseTimeout

int getAutoCloseTimeout()

gets the automatic time to close window when using client auth. This value is a method property.

Returns:

the authomatic time to close window

getAuthenticationURL

String getAuthenticationURL()
                     throws Exception

Specifies the URL which the authentication assistant must use to authenticate the portal for the current system

Returns:

system URL

Throws:

Exception - An exception including the suitible HTTP Authentication error message.

getUserParameterID

String getUserParameterID()
                   throws Exception

The parameter ID that specifies the name of the user in the authentication URL. Valid only if you select 'GET' or 'POST' as the Authentication Method type.

Returns:

user ID

Throws:

Exception - An exception including the suitible HTTP Authentication error message.

getPasswordParameterID

String getPasswordParameterID()
                       throws Exception

The parameter ID that specifies the password of the user in the authentication URL. Valid only if you select 'GET' or 'POST' as the Authentication Method type

Returns:

password ID

Throws:

Exception - An exception including the suitible HTTP Authentication error message.

getMethodParameterID

String getMethodParameterID()
                     throws Exception

Specifies how the client's browser or the server sends the authentication information to the back-end system

Returns:

The method type: GET\POST\Basic Authentication\Other

Throws:

Exception - An exception including the suitible HTTP Authentication error message.

IsAuthenticationAssistantActivated

String IsAuthenticationAssistantActivated()
                                   throws Exception

Allows the user to enable or disable the authentication assistant process for portal components based on the current system.

Returns:

if the authentication assistant is activated: Enable\Disable

Throws:

Exception - An exception including the suitible HTTP Authentication error message.

GetAuthenticationAssistantType

String GetAuthenticationAssistantType()
                               throws Exception

Specifies if the authentication is done on the server or on the client side

Returns:

auth type: Client\Server

Throws:

Exception - An exception including the suitible HTTP Authentication error message.

GetCustomServiceID

String GetCustomServiceID()
                   throws Exception

Specifies the unique name of a portal service used by the current system that implements a customized authentication method. Valid only if you select 'Other' as the Authentication Method type

Returns:

custom service ID value

Throws:

Exception - An exception including the suitible HTTP Authentication error message.

IsPermanentAuth

String IsPermanentAuth()
                throws Exception

Choosing the enable option makes the authentication on the client side occur every time an iView\ portal component is loaded. Choosing here the Disable option makes the authentication process occur only one time per session.

Returns:

if the auth is a permanent one: Enable\Disable

Throws:

Exception - An exception including the suitible HTTP Authentication error message.