PasswordPolicyControl.java

/*
 * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.security.ldap.ppolicy;

import javax.naming.ldap.Control;

/**
 *
 * A Password Policy request control.
 * <p>
 * Based on the information in the corresponding <a href=
 * "http://tools.ietf.org/draft/draft-behera-ldap-password-policy/draft-behera-ldap-password-policy-09.txt"
 * > internet draft on LDAP password policy</a>
 *
 * @author Stefan Zoerner
 * @author Luke Taylor
 *
 * @see PasswordPolicyResponseControl
 */
public class PasswordPolicyControl implements Control {
	// ~ Static fields/initializers
	// =====================================================================================

	/** OID of the Password Policy Control */
	public static final String OID = "1.3.6.1.4.1.42.2.27.8.5.1";

	// ~ Instance fields
	// ================================================================================================

	private final boolean critical;

	// ~ Constructors
	// ===================================================================================================

	/**
	 * Creates a non-critical (request) control.
	 */
	public PasswordPolicyControl() {
		this(Control.NONCRITICAL);
	}

	/**
	 * Creates a (request) control.
	 *
	 * @param critical indicates whether the control is critical for the client
	 */
	public PasswordPolicyControl(boolean critical) {
		this.critical = critical;
	}

	// ~ Methods
	// ========================================================================================================

	/**
	 * Retrieves the ASN.1 BER encoded value of the LDAP control. The request value for
	 * this control is always empty.
	 *
	 * @return always null
	 */
	public byte[] getEncodedValue() {
		return null;
	}

	/**
	 * Returns the OID of the Password Policy Control ("1.3.6.1.4.1.42.2.27.8.5.1").
	 */
	public String getID() {
		return OID;
	}

	/**
	 * Returns whether the control is critical for the client.
	 */
	public boolean isCritical() {
		return critical;
	}
}