public class

AuthorizeCallback

extends Object
implements Serializable Callback
java.lang.Object
   ↳ javax.security.sasl.AuthorizeCallback

Class Overview

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).

Summary

Public Constructors
AuthorizeCallback(String authnID, String authzID)
Constructs an instance of AuthorizeCallback.
Public Methods
String getAuthenticationID()
Returns the authentication id to check.
String getAuthorizationID()
Returns the authorization id to check.
String getAuthorizedID()
Returns the id of the authorized user.
boolean isAuthorized()
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 setAuthorizedID(String id)
Sets the id of the authorized entity.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public AuthorizeCallback (String authnID, String authzID)

Constructs an instance of AuthorizeCallback.

Parameters
authnID The (authenticated) authentication id.
authzID The authorization id.

Public Methods

public String getAuthenticationID ()

Returns the authentication id to check.

Returns
  • The authentication id to check.

public String getAuthorizationID ()

Returns the authorization id to check.

Returns
  • The authentication id to check.

public String getAuthorizedID ()

Returns the id of the authorized user.

Returns
  • The id of the authorized user. null means the authorization failed.

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

public void setAuthorized (boolean ok)

Sets whether the authorization is allowed.

Parameters
ok true if authorization is allowed; false otherwise

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.