com.novell.ldap.rfc2251
Class RfcControl

java.lang.Object
  com.novell.ldap.asn1.ASN1Object
      com.novell.ldap.asn1.ASN1Structured
          com.novell.ldap.asn1.ASN1Sequence
              com.novell.ldap.rfc2251.RfcControl

All Implemented Interfaces:

java.io.Serializable

public class RfcControl

extends ASN1Sequence

Represents an LDAP Control.

        Control ::= SEQUENCE {
               controlType             LDAPOID,
               criticality             BOOLEAN DEFAULT FALSE,
               controlValue            OCTET STRING OPTIONAL }

See Also:

Serialized Form

Field Summary

Fields inherited from class com.novell.ldap.asn1.ASN1Sequence

TAG

Fields inherited from class com.novell.ldap.asn1.ASN1Structured

Fields inherited from class com.novell.ldap.asn1.ASN1Object

Constructor Summary

RfcControl(ASN1Decoder dec, java.io.InputStream in, int len)
Constructs a Control object by decoding it from an InputStream.

RfcControl(ASN1Sequence seqObj)
Constructs a Control object by decoding from an ASN1Sequence

RfcControl(RfcLDAPOID controlType)

RfcControl(RfcLDAPOID controlType, ASN1Boolean criticality)

RfcControl(RfcLDAPOID controlType, ASN1Boolean criticality, ASN1OctetString controlValue)
Note: criticality is only added if true, as per RFC 2251 sec 5.1 part (4): If a value of a type is its default value, it MUST be absent.

Method Summary

ASN1OctetString	getControlType()
ASN1OctetString	getControlValue() Since controlValue is an OPTIONAL component, we need to check to see if one is available.
ASN1Boolean	getCriticality() Returns criticality.
void	setControlValue(ASN1OctetString controlValue) Called to set/replace the ControlValue.

Methods inherited from class com.novell.ldap.asn1.ASN1Sequence

toString

Methods inherited from class com.novell.ldap.asn1.ASN1Structured

add, decodeStructured, encode, get, set, size, toArray, toString

Methods inherited from class com.novell.ldap.asn1.ASN1Object

getEncoding, getIdentifier, setIdentifier

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RfcControl

public RfcControl(RfcLDAPOID controlType)

RfcControl

public RfcControl(RfcLDAPOID controlType,
                  ASN1Boolean criticality)

RfcControl

public RfcControl(RfcLDAPOID controlType,
                  ASN1Boolean criticality,
                  ASN1OctetString controlValue)

Note: criticality is only added if true, as per RFC 2251 sec 5.1 part (4): If a value of a type is its default value, it MUST be absent.

RfcControl

public RfcControl(ASN1Decoder dec,
                  java.io.InputStream in,
                  int len)
           throws java.io.IOException

Constructs a Control object by decoding it from an InputStream.

RfcControl

public RfcControl(ASN1Sequence seqObj)
           throws java.io.IOException

Constructs a Control object by decoding from an ASN1Sequence

Method Detail

getControlType

public final ASN1OctetString getControlType()

getCriticality

public final ASN1Boolean getCriticality()

Returns criticality. If no value present, return the default value of FALSE.

getControlValue

public final ASN1OctetString getControlValue()

Since controlValue is an OPTIONAL component, we need to check to see if one is available. Remember that if criticality is of default value, it will not be present.

setControlValue

public final void setControlValue(ASN1OctetString controlValue)

Called to set/replace the ControlValue. Will normally be called by the child classes after the parent has been instantiated.