gcc/libjava/classpath/javax/security/sasl/AuthorizeCallback.java

/* 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. */


package javax.security.sasl;

import java.io.Serializable;
import javax.security.auth.callback.Callback;

/**
 * This callback is used by {@link 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
 */
public class AuthorizeCallback implements Callback, Serializable
{
  // Constants and variables
  // -------------------------------------------------------------------------

  private static final long serialVersionUID = -2353344186490470805L;

  /** @serial The (authenticated) authentication id to check. */
  private String authenticationID = null;

  /** @serial The authorization id to check. */
  private String authorizationID  = null;

  /**
   * @serial The id of the authorized entity. If null, the id of the authorized
   * entity is authorizationID.
   */
  private String authorizedID  = null;

  /**
   * @serial A flag indicating whether the authentication id is allowed to act
   * on behalf of the authorization id.
   */
  private boolean authorized = false;

  // Constructor(s)
  // -------------------------------------------------------------------------

  /**
   * Constructs an instance of <code>AuthorizeCallback</code>.
   *
   * @param authnID the (authenticated) authentication ID.
   * @param authzID the authorization ID.
   */
  public AuthorizeCallback(String authnID, String authzID)
  {
    super();

    this.authenticationID = authnID;
    this.authorizationID  = authzID;
  }

  // Class methods
  // -------------------------------------------------------------------------

  // Instance methods
  // -------------------------------------------------------------------------

  /**
   * Returns the authentication ID to check.
   *
   * @return the authentication ID to check
   */
  public String getAuthenticationID()
  {
    return authenticationID;
  }

  /**
   * Returns the authorization ID to check.
   *
   * @return the authorization ID to check.
   */
  public String getAuthorizationID()
  {
    return authorizationID;
  }

  /**
   * Determines if the identity represented by authentication ID is allowed to
   * act on behalf of the authorization ID.
   *
   * @return <code>true</code> if authorization is allowed; <code>false</code>
   * otherwise.
   * @see #setAuthorized(boolean)
   * @see #getAuthorizedID()
   */
  public boolean isAuthorized()
  {
    return authorized;
  }

  /**
   * Sets if authorization is allowed or not.
   *
   * @param authorized <code>true</code> if authorization is allowed;
   * <code>false</code> otherwise.
   * @see #isAuthorized()
   * @see #setAuthorizedID(String)
   */
  public void setAuthorized(boolean authorized)
  {
    this.authorized = authorized;
  }

  /**
   * Returns the ID of the authorized user.
   *
   * @return the ID of the authorized user. <code>null</code> means the
   * authorization failed.
   * @see #setAuthorized(boolean)
   * @see #setAuthorizedID(String)
   */
  public String getAuthorizedID()
  {
    if (!authorized)
      {
        return null;
      }
    return (authorizedID != null ? authorizedID : authorizationID);
  }

  /**
   * Sets the ID of the authorized entity. Called by handler only when the ID
   * is different from {@link #getAuthorizationID()}. For example, the ID might
   * need to be canonicalized for the environment in which it will be used.
   *
   * @see #setAuthorized(boolean)
   * @see #getAuthorizedID()
   */
  public void setAuthorizedID(String id)
  {
    this.authorizedID = id;
  }
}