Class AuthorizeCallback

java.lang.Object
javax.security.sasl.AuthorizeCallback
All Implemented Interfaces:
Serializable, Callback

public class AuthorizeCallback extends Object implements Callback, Serializable
This callback is used by SaslServer to determine whether one entity (identified by an authenticated authentication id) can act on behalf of another entity (identified by an authorization id).
Since:
1.5
See Also:
  • Constructor Summary

    Constructors
    Constructor
    Description
    AuthorizeCallback(String authnID, String authzID)
    Constructs an instance of AuthorizeCallback.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the authentication id to check.
    Returns the authorization id to check.
    Returns the id of the authorized user.
    boolean
    Determines whether the authentication id is allowed to act on behalf of the authorization id.
    void
    setAuthorized(boolean ok)
    Sets whether the authorization is allowed.
    void
    Sets the id of the authorized entity.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    Creates and returns a copy of this object.
    boolean
    Indicates whether some other object is "equal to" this one.
    protected void
    Deprecated, for removal: This API element is subject to removal in a future version.
    Finalization is deprecated and subject to removal in a future release.
    final Class<?>
    Returns the runtime class of this Object.
    int
    Returns a hash code value for this object.
    final void
    Wakes up a single thread that is waiting on this object's monitor.
    final void
    Wakes up all threads that are waiting on this object's monitor.
    Returns a string representation of the object.
    final void
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
    final void
    wait(long timeoutMillis)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
    final void
    wait(long timeoutMillis, int nanos)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
  • Constructor Details

    • AuthorizeCallback

      public AuthorizeCallback(String authnID, String authzID)
      Constructs an instance of AuthorizeCallback.
      Parameters:
      authnID - The (authenticated) authentication id.
      authzID - The authorization id.
  • Method Details

    • getAuthenticationID

      public String getAuthenticationID()
      Returns the authentication id to check.
      Returns:
      The authentication id to check.
    • getAuthorizationID

      public String getAuthorizationID()
      Returns the authorization id to check.
      Returns:
      The authentication id to check.
    • isAuthorized

      public boolean isAuthorized()
      Determines whether the authentication id is allowed to act on behalf of the authorization id.
      Returns:
      true if authorization is allowed; false otherwise
      See Also:
    • setAuthorized

      public void setAuthorized(boolean ok)
      Sets whether the authorization is allowed.
      Parameters:
      ok - true if authorization is allowed; false otherwise
      See Also:
    • getAuthorizedID

      public String getAuthorizedID()
      Returns the id of the authorized user.
      Returns:
      The id of the authorized user. null means the authorization failed.
      See Also:
    • setAuthorizedID

      public void setAuthorizedID(String id)
      Sets the id of the authorized entity. Called by handler only when the id is different from getAuthorizationID(). For example, the id might need to be canonicalized for the environment in which it will be used.
      Parameters:
      id - The id of the authorized user.
      See Also: