BindResponseProtocolOp.java revision 998747bfaaa3c6b28bbfaf0e282e6c0ccbf46bc0
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at legal-notices/CDDLv1_0.txt.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
* Portions Copyright 2014-2015 ForgeRock AS
*/
/**
* This class defines the structures and methods for an LDAP delete response
* protocol op, which is used to provide information about the result of
* processing a delete request.
*/
public class BindResponseProtocolOp
extends ProtocolOp
{
// The server SASL credentials for this response.
private ByteString serverSASLCredentials;
// The matched DN for this response.
// The result code for this response.
private int resultCode;
// The set of referral URLs for this response.
// The error message for this response.
private LocalizableMessage errorMessage;
/**
* Creates a new bind response protocol op with the provided result code.
*
* @param resultCode The result code for this response.
*/
public BindResponseProtocolOp(int resultCode)
{
this.resultCode = resultCode;
errorMessage = null;
referralURLs = null;
}
/**
* Creates a new bind response protocol op with the provided result code and
* error message.
*
* @param resultCode The result code for this response.
* @param errorMessage The error message for this response.
*/
{
this.resultCode = resultCode;
this.errorMessage = errorMessage;
referralURLs = null;
}
/**
* Creates a new bind response protocol op with the provided information.
*
* @param resultCode The result code for this response.
* @param errorMessage The error message for this response.
* @param matchedDN The matched DN for this response.
* @param referralURLs The referral URLs for this response.
*/
{
this.resultCode = resultCode;
this.errorMessage = errorMessage;
this.referralURLs = referralURLs;
}
/**
* Creates a new bind response protocol op with the provided information.
*
* @param resultCode The result code for this response.
* @param errorMessage The error message for this response.
* @param matchedDN The matched DN for this response.
* @param referralURLs The referral URLs for this response.
* @param serverSASLCredentials The server SASL credentials for this
*/
{
this.resultCode = resultCode;
this.errorMessage = errorMessage;
this.referralURLs = referralURLs;
}
/**
* Retrieves the result code for this response.
*
* @return The result code for this response.
*/
public int getResultCode()
{
return resultCode;
}
/**
* Retrieves the error message for this response.
*
* @return The error message for this response, or <CODE>null</CODE> if none
* is available.
*/
public LocalizableMessage getErrorMessage()
{
return errorMessage;
}
/**
* Retrieves the matched DN for this response.
*
* @return The matched DN for this response, or <CODE>null</CODE> if none is
* available.
*/
public DN getMatchedDN()
{
return matchedDN;
}
/**
* Retrieves the set of referral URLs for this response.
*
* @return The set of referral URLs for this response, or <CODE>null</CODE>
* if none are available.
*/
{
return referralURLs;
}
/**
* Retrieves the server SASL credentials for this response.
*
* @return The server SASL credentials for this response, or
* <CODE>null</CODE> if there are none.
*/
public ByteString getServerSASLCredentials()
{
return serverSASLCredentials;
}
/**
* Retrieves the BER type for this protocol op.
*
* @return The BER type for this protocol op.
*/
public byte getType()
{
return OP_TYPE_BIND_RESPONSE;
}
/**
* Retrieves the name for this protocol op type.
*
* @return The name for this protocol op type.
*/
public String getProtocolOpName()
{
return "Bind Response";
}
/**
* Writes this protocol op to an ASN.1 output stream.
*
* @param stream The ASN.1 output stream to write to.
* @throws IOException If a problem occurs while writing to the stream.
*/
{
{
}
else
{
}
if(errorMessage == null)
{
}
else
{
}
{
for (String s : referralURLs)
{
}
}
if (serverSASLCredentials != null)
{
}
}
/**
* Appends a string representation of this LDAP protocol op to the provided
* buffer.
*
* @param buffer The buffer to which the string should be appended.
*/
{
{
}
{
}
{
{
}
}
if (serverSASLCredentials != null)
{
}
}
/**
* Appends a multi-line string representation of this LDAP protocol op to the
* provided buffer.
*
* @param buffer The buffer to which the information should be appended.
* @param indent The number of spaces from the margin that the lines should
* be indented.
*/
{
for (int i=0 ; i < indent; i++)
{
}
if (errorMessage != null)
{
}
{
}
{
for (String s : referralURLs)
{
}
}
if (serverSASLCredentials != null)
{
}
}
}