com.cognos.CAM_AAA.authentication

Interface IBiBusHeader

All Known Subinterfaces:

IBiBusHeader2, ITrustedSignonRequest

public interface IBiBusHeader

Defines the interface to use for accessing an IBM Cognos biBusHeader. Only the properties used for authentication are accessible.

Method Summary

Modifier and Type	Method and Description
void	consumeFormField(java.lang.String theName) Removes the specified form field variable from the biBusheader object.
java.util.Locale	getContentLocale() Returns the preferred content locale for the session.
java.lang.String[]	getCookieValue(java.lang.String theName) Returns all the values for the specified cookie variable.
java.lang.String[]	getCredentialValue(java.lang.String theName) Returns all the values for the specified name portion of the name-value pairs in the credential.
java.lang.String[]	getEnvVarValue(java.lang.String theName) Returns all the values for the specified environment variable or null if it does not exist.
java.lang.String[]	getFormFieldValue(java.lang.String theName) Returns all the values for the specified form field variable.
java.util.Locale	getProductLocale() Returns the preferred product locale for the session.
java.lang.String[]	getTrustedEnvVarValue(java.lang.String theName) Returns all the values for the specified trusted environment variable, or null if it does not exist.
void	setCookie(java.lang.String theName, java.lang.String theValue, int theMaxAge, java.lang.String thePath, java.lang.String theDomain, boolean theSecureFlag) Sets a cookie value in the biBusHeader object.

Method Detail

getCredentialValue

java.lang.String[] getCredentialValue(java.lang.String theName)

Returns all the values for the specified name portion of the name-value pairs in the credential. Returns null if none exists.

Parameters:

theName - The name portion of the required name-value pairs in the credential.

Returns:

An array of all values corresponding to the specified name.

getFormFieldValue

java.lang.String[] getFormFieldValue(java.lang.String theName)

Returns all the values for the specified form field variable. Returns null if none exists.

Parameters:

theName - The name of the form field variable to retrieve.

Returns:

An array containing all the values of the specified form field variable.

getCookieValue

java.lang.String[] getCookieValue(java.lang.String theName)

Returns all the values for the specified cookie variable. Returns null if none exists.

Parameters:

theName - The name of the cookie variable to retrieve.

Returns:

The value of the cookie variable.

getEnvVarValue

java.lang.String[] getEnvVarValue(java.lang.String theName)

Returns all the values for the specified environment variable or null if it does not exist. Not all environment variables are transmitted on the biBusHeader.

Parameters:

theName - The name of the environment variable to retrieve.

Returns:

The value of the environment variable.

getTrustedEnvVarValue

java.lang.String[] getTrustedEnvVarValue(java.lang.String theName)

Returns all the values for the specified trusted environment variable, or null if it does not exist. A trusted environment variable is an environment variable that has been set by a trusted party (i.e. a Cognos gateway, the dispatcher or a trusted signon namespace). The required variable is identified in a SystemRecoverableException, which an authentication provider throws when there is missing information.

Parameters:

theName - The name of the trusted environment variable to retrieve.

Returns:

The value of the trusted environment variable.

See Also:

SystemRecoverableException

consumeFormField

void consumeFormField(java.lang.String theName)

Removes the specified form field variable from the biBusheader object. Form fields variables that are no longer required, especially sensitive information such as usernames and passwords, should be removed from the biBusHeader.

Parameters:

theName - The name of the form field variable to remove.

setCookie

void setCookie(java.lang.String theName,
               java.lang.String theValue,
               int theMaxAge,
               java.lang.String thePath,
               java.lang.String theDomain,
               boolean theSecureFlag)

Sets a cookie value in the biBusHeader object. This class supports Version 0 of the Netscape cookie specification

Parameters:

theName - The name of the cookie.

theValue - The value to assign to the cookie.

theMaxAge - A date string that specifies the valid life time of the cookie. Once theMaxAge is reached, the cookie will expire. If this value is set to 0, the cookie will last for the duration of the browser session. If the value is set to -1, then the cookie has expired.

thePath - Specifies the subset of URLs in a domain for which the cookie is valid.

theDomain - Specifies the domain in which the cookie will be visible. The default value of domain is the host name of the server that generated the cookie response.

theSecureFlag - Specifies whether the cookie should be secured. If true, the browser will not pass the cookie to the Web server unless the Web page is being viewed over a secure connection. Currently this means that secure cookies will only be sent to HTTPS (HTTP over SSL) servers.

getProductLocale

java.util.Locale getProductLocale()

Returns the preferred product locale for the session. The product locale determines the language and data format for the user interface.

Returns:

The product locale for the session.

getContentLocale

java.util.Locale getContentLocale()

Returns the preferred content locale for the session. The content locale determines the language and data format of the returned content.

Returns:

The content locale for the session.