eu.geclipse.core.auth
Class AuthTokenRequest

java.lang.Object
  eu.geclipse.core.auth.AuthTokenRequest

public class AuthTokenRequest
extends java.lang.Object

This class is used by token requesters in order to specify the type of the token, a name for the requester and the purpose of the token. The requester name and the purpose may be used to present the user some additional information if user interaction is needed in order to create a new token.

Constructor Summary

AuthTokenRequest(IAuthenticationTokenDescription description, java.lang.String requester, java.lang.String purpose)
Create a new token request from the specified parameters.

Method Summary

IAuthenticationTokenDescription	getDescription() Get the token description.
java.lang.String	getPurpose() Get the token's purpose.
java.lang.String	getRequester() Get the token requester.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthTokenRequest

public AuthTokenRequest(IAuthenticationTokenDescription description,
                        java.lang.String requester,
                        java.lang.String purpose)

Create a new token request from the specified parameters. Any of the parameters may be null. If the token description is null any type of token will be returned.

Parameters:

description - The token description that determines which type of token is requested. One or more parameters of the description are not null only tokens will be returned that fulfill these parameters.

requester - A short descriptive text representing the requester or consumer of the token.

purpose - A descriptive text denoting the purpose of the token.

Method Detail

getDescription

public IAuthenticationTokenDescription getDescription()

Get the token description.

Returns:

The token description used to query the token.

getPurpose

public java.lang.String getPurpose()

Get the token's purpose.

Returns:

A descriptive text denoting the purpose of the token.

getRequester

public java.lang.String getRequester()

Get the token requester.

Returns:

A short descriptive text representing the requester or consumer of the token.