org.eclipse.stardust.engine.core.spi.security

Class ExternalLoginResult

java.lang.Object

org.eclipse.stardust.engine.core.spi.security.ExternalLoginResult

All Implemented Interfaces:

Serializable

public final class ExternalLoginResult
extends Object
implements Serializable

Data value object wrapping the result of an authentication request.

Version:

$Revision$

Author:

rsauer

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
org.eclipse.stardust.common.error.LoginFailedException	getLoginFailedReason() Queries for the reason the authentification failed.
Map	getProperties() Queries for the overiding properties.
String	getUserId() Gets the userId which will be used for user identification / synchronization in subsequent method calls - can be null
boolean	isOverridingProperties() Queries for the existence of overiding properties.
static ExternalLoginResult	testifyFailure(org.eclipse.stardust.common.error.LoginFailedException reason) Testifies a failed authentification.
static ExternalLoginResult	testifyFailure(String userId, org.eclipse.stardust.common.error.LoginFailedException reason) Testifies a failed authentification.
static ExternalLoginResult	testifySuccess() Testifies a successful authentication.
static ExternalLoginResult	testifySuccess(Map properties) Testifies a successful authentication.
static ExternalLoginResult	testifySuccess(String userId) Testifies a successful authentication.
static ExternalLoginResult	testifySuccess(String userId, Map properties) Testifies a successful authentication.
boolean	wasSuccessful() Queries for success.

Methods inherited from class java.lang.Object

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

Method Detail

testifySuccess

public static final ExternalLoginResult testifySuccess()

Testifies a successful authentication.

Returns:

The sucess ticket.

testifySuccess

public static final ExternalLoginResult testifySuccess(String userId)

Testifies a successful authentication.

Parameters:

userId - - the userId which will be used for user identification / synchronization in subsequent method calls - can be null

Returns:

The sucess ticket.

testifySuccess

public static final ExternalLoginResult testifySuccess(Map properties)

Testifies a successful authentication.

Parameters:

properties - The modified properties map. null results in an empty map.

Returns:

The sucess ticket.

testifySuccess

public static final ExternalLoginResult testifySuccess(String userId,
                                 Map properties)

Testifies a successful authentication.

Parameters:

userId - - the userId which will be used for user identification / synchronization in subsequent method calls - can be null

properties - The modified properties map. null results in an empty map.

Returns:

The sucess ticket.

testifyFailure

public static final ExternalLoginResult testifyFailure(org.eclipse.stardust.common.error.LoginFailedException reason)

Testifies a failed authentification.

Parameters:

reason - The reason the authentication went fail.

Returns:

The failure ticket.

testifyFailure

public static final ExternalLoginResult testifyFailure(String userId,
                                 org.eclipse.stardust.common.error.LoginFailedException reason)

Testifies a failed authentification.

Parameters:

userId - - the userId which will be used for user identification / synchronization in subsequent method calls - can be null

reason - The reason the authentication went fail.

Returns:

The failure ticket.

wasSuccessful

public boolean wasSuccessful()

Queries for success.

Returns:

The success indicator.

getLoginFailedReason

public org.eclipse.stardust.common.error.LoginFailedException getLoginFailedReason()

Queries for the reason the authentification failed.

Returns:

The reason for failure.

isOverridingProperties

public boolean isOverridingProperties()

Queries for the existence of overiding properties. These can be accessed by getProperties().

Returns:

The existence of an overiding properties.

getProperties

public Map getProperties()

Queries for the overiding properties. The map may be empty.

Returns:

The overiding properties.

getUserId

public String getUserId()

Gets the userId which will be used for user identification / synchronization in subsequent method calls - can be null

Returns:

the user id