com.atlassian.sal.api.auth

Class Authenticator.Result.Success

java.lang.Object

com.atlassian.sal.api.auth.Authenticator.Result

com.atlassian.sal.api.auth.Authenticator.Result.Success

Enclosing class:

Authenticator.Result

public static final class Authenticator.Result.Success
extends Authenticator.Result

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.sal.api.auth.Authenticator.Result

Authenticator.Result.Error, Authenticator.Result.Failure, Authenticator.Result.NoAttempt, Authenticator.Result.Status, Authenticator.Result.Success

Constructor Summary

Constructors

Constructor and Description
Success(Message message, Principal principal) Construct a success result for a particular principal with a result message.
Success(Principal principal) Deprecated. since 2.0.10, use Success#Success(Message, Principal)

Method Summary

Methods inherited from class com.atlassian.sal.api.auth.Authenticator.Result

getMessage, getPrincipal, getStatus

Methods inherited from class java.lang.Object

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

Constructor Detail

Success

@Deprecated
public Success(Principal principal)

Deprecated. since 2.0.10, use Success#Success(Message, Principal)

Construct a success result for a particular principal.

Parameters:

principal - the successfully-authenticated principal

Success

public Success(Message message,
               Principal principal)

Construct a success result for a particular principal with a result message.

Parameters:

message - a message indicating the success of this result

principal - the successfully-authenticated principal

Since:

2.0.7