Class PlainClient

Implemented Interfaces:

public class PlainClient
extends ClientMechanism
implements SaslClient

The PLAIN SASL client-side mechanism.

Field Summary

Fields inherited from class gnu.javax.crypto.sasl.ClientMechanism

authorizationID, channelBinding, complete, handler, mechanism, properties, protocol, serverName, state

Constructor Summary

The basic constructor.

Method Summary

evaluateChallenge(byte[] challenge)
Evaluates the challenge data and generates a response.
protected String
Determines if this mechanism has an optional initial response.
protected void
protected void

Methods inherited from class gnu.javax.crypto.sasl.ClientMechanism

dispose, engineUnwrap, engineWrap, evaluateChallenge, getAuthorizationID, getMechanismName, getNegotiatedMaxBuffer, getNegotiatedPolicyForwardSecrecy, getNegotiatedPolicyNoActive, getNegotiatedPolicyNoAnonymous, getNegotiatedPolicyNoDictionary, getNegotiatedPolicyNoPlainText, getNegotiatedPolicyPassCredentials, getNegotiatedProperty, getNegotiatedQOP, getNegotiatedRawSendSize, getNegotiatedServerAuth, getNegotiatedStrength, getReuse, hasInitialResponse, init, initMechanism, isComplete, reset, resetMechanism, unwrap, wrap

Methods inherited from class java.lang.Object

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

Constructor Details


public PlainClient()
The basic constructor. Object is special, because it has no superclass, so there is no call to super().

Method Details


public byte[] evaluateChallenge(byte[] challenge)
            throws SaslException
Evaluates the challenge data and generates a response. If a challenge is received from the server during the authentication process, this method is called to prepare an appropriate next response to submit to the server.
Specified by:
evaluateChallenge in interface SaslClient
evaluateChallenge in interface ClientMechanism
challenge - the non-null challenge sent from the server. The challenge array may have zero length.
the possibly null reponse to send to the server. It is null if the challenge accompanied a "SUCCESS" status and the challenge only contains data for the client to update its state and no response needs to be sent to the server. The response is a zero-length byte array if the client is to send a response with no data.
SaslException - if an error occurred while processing the challenge or generating a response.


protected String getNegotiatedQOP()
getNegotiatedQOP in interface ClientMechanism


public boolean hasInitialResponse()
Determines if this mechanism has an optional initial response. If true, caller should call SaslClient.evaluateChallenge(byte[]) with an empty array to get the initial response.
Specified by:
hasInitialResponse in interface SaslClient
hasInitialResponse in interface ClientMechanism
true if this mechanism has an initial response.


protected void initMechanism()
            throws SaslException
initMechanism in interface ClientMechanism


protected void resetMechanism()
            throws SaslException
resetMechanism in interface ClientMechanism -- Copyright (C) 2003, 2006 Free Software Foundation, Inc. This file is a 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 of the License, 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; if not, write to the Free Software Foundation, Inc., 51 Franklin St, 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.