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

java.lang.Object
  extended by org.eclipse.stardust.engine.core.spi.security.LoginResult
All Implemented Interfaces:
Serializable

public final class LoginResult
extends Object
implements Serializable

Data value object wrapping the result of an authentication request.

Version:
$Revision$
Author:
rsauer
See Also:
Serialized Form

Method Summary
 org.eclipse.stardust.common.error.LoginFailedException getLoginFailedReason()
          Queries for the reason the authentification failed.
static LoginResult testifyFailure(org.eclipse.stardust.common.error.LoginFailedException reason)
          Testifies a failed authentification.
static LoginResult testifySuccess()
          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 LoginResult testifySuccess()
Testifies a successful authentication.

Returns:
The sucess ticket.

testifyFailure

public static final LoginResult testifyFailure(org.eclipse.stardust.common.error.LoginFailedException reason)
Testifies a failed authentification.

Parameters:
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.


Copyright © 2017 Eclipse Stardust. All Rights Reserved.