javax.security.sasl

Class AuthorizeCallback

Implemented Interfaces:
Callback, Serializable

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:
Serialized Form

Constructor Summary

AuthorizeCallback(String authnID, String authzID)
Constructs an instance of AuthorizeCallback.

Method Summary

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 if the identity represented by authentication ID is allowed to act on behalf of the authorization ID.
void
setAuthorized(boolean authorized)
Sets if authorization is allowed or not.
void
setAuthorizedID(String id)
Sets the ID of the authorized entity.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

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 authorization ID to check.

getAuthorizedID

public String getAuthorizedID()
Returns the ID of the authorized user.
Returns:
the ID of the authorized user. null means the authorization failed.

isAuthorized

public boolean isAuthorized()
Determines if the identity represented by authentication ID is allowed to act on behalf of the authorization ID.
Returns:
true if authorization is allowed; false otherwise.

setAuthorized

public void setAuthorized(boolean authorized)
Sets if authorization is allowed or not.
Parameters:
authorized - true if authorization is allowed; false otherwise.

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.

AuthorizeCallback.java -- Copyright (C) 2003, 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.