org.apache.directory.api.asn1.ber

Class AbstractContainer

java.lang.Object

org.apache.directory.api.asn1.ber.AbstractContainer

All Implemented Interfaces:

Asn1Container

Direct Known Subclasses:

AdDirSyncContainer, CancelContainer, CertGenerationContainer, EntryChangeContainer, GracefulDisconnectContainer, GracefulShutdownContainer, LdapMessageContainer, PagedResultsContainer, PasswordModifyRequestContainer, PasswordModifyResponseContainer, PasswordPolicyContainer, PersistentSearchContainer, SortRequestContainer, SortResponseContainer, StoredProcedureContainer, SubentriesContainer, SyncDoneValueContainer, SyncInfoValueContainer, SyncRequestValueContainer, SyncStateValueContainer, VirtualListViewRequestContainer, VirtualListViewResponseContainer, WhoAmIResponseContainer

public abstract class AbstractContainer
extends java.lang.Object
implements Asn1Container

This class is the abstract container used to store the current state of a PDU being decoded. It also stores the grammars used to decode the PDU, and all the informations needed to decode a PDU.

Field Summary

Fields

Modifier and Type	Field and Description
private int	decodedBytes A counter for the decoded bytes
private boolean	gathering A flag telling if the Value should be accumulated before being decoded for constructed types
private Grammar<?>	grammar All the possible grammars
private boolean	grammarEndAllowed The grammar end transition flag
private int	id The incremental id used to tag TLVs
private int	maxPDUSize The maximum allowed size for a PDU.
private TLV	parentTLV The parent TLV
private TLVStateEnum	state The current state of the decoding
private java.nio.ByteBuffer	stream The Stream being decoded
private TLV	tlv The current TLV
private java.lang.Enum<?>	transition The current transition

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractContainer() Creates a new instance of AbstractContainer with a starting state.
protected	AbstractContainer(java.nio.ByteBuffer stream) Creates a new instance of AbstractContainer with a starting state.

Method Summary

Modifier and Type	Method and Description
void	clean() Clean the container for the next usage.
TLV	getCurrentTLV() Gets the currentTLV
int	getDecodedBytes()
Grammar<?>	getGrammar() Gets the grammar
int	getMaxPDUSize()
int	getNewTlvId() Gets a new TLV id
TLV	getParentTLV()
TLVStateEnum	getState() Gets the current grammar state
java.nio.ByteBuffer	getStream() Gets the current stream containing the bytes to decode
int	getTlvId() Gets the current TLV id
java.lang.Enum<?>	getTransition() Gets the transition
void	incrementDecodedBytes(int nb) Increment the decodedBytes by the latest received buffer's size.
boolean	isGathering()
boolean	isGrammarEndAllowed() Checks that we can have a end state after this transition
void	rewind() Move backward in the stream to the first byte for a given TLV.
void	setCurrentTLV(TLV currentTLV) Sets the current TLV
void	setDecodedBytes(int decodedBytes)
void	setGathering(boolean gathering) Set the isGathering flag
void	setGrammar(Grammar<?> grammar) Sets the grammar
void	setGrammarEndAllowed(boolean grammarEndAllowed) Sets the flag to allow a end transition
void	setMaxPDUSize(int maxPDUSize) Set the maximum PDU size.
void	setParentTLV(TLV parentTLV) Sets the parent TLV
void	setState(TLVStateEnum state) Sets the new current state
void	setStream(java.nio.ByteBuffer stream) Stores the Stream being decoded
void	setTransition(java.lang.Enum<?> transition) Updates the transition from a state to another
void	updateParent() Update the parent's length

Methods inherited from class java.lang.Object

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

Field Detail

grammar

private Grammar<?> grammar

All the possible grammars

state

private TLVStateEnum state

The current state of the decoding

transition

private java.lang.Enum<?> transition

The current transition

tlv

private TLV tlv

The current TLV

parentTLV

private TLV parentTLV

The parent TLV

grammarEndAllowed

private boolean grammarEndAllowed

The grammar end transition flag

decodedBytes

private int decodedBytes

A counter for the decoded bytes

maxPDUSize

private int maxPDUSize

The maximum allowed size for a PDU. Default to MAX int value

id

private int id

The incremental id used to tag TLVs

stream

private java.nio.ByteBuffer stream

The Stream being decoded

gathering

private boolean gathering

A flag telling if the Value should be accumulated before being decoded for constructed types

Constructor Detail

AbstractContainer

protected AbstractContainer()

Creates a new instance of AbstractContainer with a starting state.

AbstractContainer

protected AbstractContainer(java.nio.ByteBuffer stream)

Creates a new instance of AbstractContainer with a starting state.

Parameters:

stream - the buffer containing the data to decode

Method Detail

getGrammar

public Grammar<?> getGrammar()

Gets the grammar

Specified by:

getGrammar in interface Asn1Container

Returns:

Returns the grammar used to decode a LdapMessage.

setGrammar

public void setGrammar(Grammar<?> grammar)

Sets the grammar

Specified by:

setGrammar in interface Asn1Container

Parameters:

grammar - The grammar to set

getState

public TLVStateEnum getState()

Gets the current grammar state

Specified by:

getState in interface Asn1Container

Returns:

Returns the current grammar state

setState

public void setState(TLVStateEnum state)

Sets the new current state

Specified by:

setState in interface Asn1Container

Parameters:

state - The new state

isGrammarEndAllowed

public boolean isGrammarEndAllowed()

Checks that we can have a end state after this transition

Specified by:

isGrammarEndAllowed in interface Asn1Container

Returns:

true if this can be the last transition

setGrammarEndAllowed

public void setGrammarEndAllowed(boolean grammarEndAllowed)

Sets the flag to allow a end transition

Specified by:

setGrammarEndAllowed in interface Asn1Container

Parameters:

grammarEndAllowed - true or false, depending on the next transition being an end or not.

getTransition

public java.lang.Enum<?> getTransition()

Gets the transition

Specified by:

getTransition in interface Asn1Container

Returns:

Returns the transition from the previous state to the new state

setTransition

public void setTransition(java.lang.Enum<?> transition)

Updates the transition from a state to another

Specified by:

setTransition in interface Asn1Container

Parameters:

transition - The transition to set

setCurrentTLV

public void setCurrentTLV(TLV currentTLV)

Sets the current TLV

Specified by:

setCurrentTLV in interface Asn1Container

Parameters:

currentTLV - The current TLV

getCurrentTLV

public TLV getCurrentTLV()

Gets the currentTLV

Specified by:

getCurrentTLV in interface Asn1Container

Returns:

Returns the current TLV being decoded

getParentTLV

public TLV getParentTLV()

Specified by:

getParentTLV in interface Asn1Container

Returns:

The parent TLV.

setParentTLV

public void setParentTLV(TLV parentTLV)

Sets the parent TLV

Specified by:

setParentTLV in interface Asn1Container

Parameters:

parentTLV - The new parent TLV

clean

public void clean()

Clean the container for the next usage.

getNewTlvId

public int getNewTlvId()

Gets a new TLV id

Specified by:

getNewTlvId in interface Asn1Container

Returns:

a unique value representing the current TLV id

getTlvId

public int getTlvId()

Gets the current TLV id

Specified by:

getTlvId in interface Asn1Container

Returns:

a unique value representing the current TLV id

getDecodedBytes

public int getDecodedBytes()

Specified by:

getDecodedBytes in interface Asn1Container

Returns:

The number of decoded bytes for this message. This is used to control the PDU size and avoid PDU exceeding the maximum allowed size to break the server.

setDecodedBytes

public void setDecodedBytes(int decodedBytes)

Specified by:

setDecodedBytes in interface Asn1Container

incrementDecodedBytes

public void incrementDecodedBytes(int nb)

Increment the decodedBytes by the latest received buffer's size.

Specified by:

incrementDecodedBytes in interface Asn1Container

Parameters:

nb - The buffer size.

getMaxPDUSize

public int getMaxPDUSize()

Specified by:

getMaxPDUSize in interface Asn1Container

Returns:

The maximum PDU size.

setMaxPDUSize

public void setMaxPDUSize(int maxPDUSize)

Set the maximum PDU size.

Specified by:

setMaxPDUSize in interface Asn1Container

Parameters:

maxPDUSize - The maximum PDU size (if negative or null, will be replaced by the max integer value)

getStream

public java.nio.ByteBuffer getStream()

Gets the current stream containing the bytes to decode

Specified by:

getStream in interface Asn1Container

Returns:

The current stream

setStream

public void setStream(java.nio.ByteBuffer stream)

Stores the Stream being decoded

Specified by:

setStream in interface Asn1Container

Parameters:

stream - The stream being decoded

rewind

public void rewind()

Move backward in the stream to the first byte for a given TLV. This is useful when we have read some Tag and Length in order to define the next transition, and if this transition do a grammar switch.

Specified by:

rewind in interface Asn1Container

updateParent

public void updateParent()

Update the parent's length

Specified by:

updateParent in interface Asn1Container

isGathering

public boolean isGathering()

Specified by:

isGathering in interface Asn1Container

Returns:

true if the container should gather the value into itself, false if the decoding of the Value part should be done immediately for constructed types.

setGathering

public void setGathering(boolean gathering)

Set the isGathering flag

Specified by:

setGathering in interface Asn1Container

Parameters:

gathering - true to ask the Asn1Decoder to gather the data into the container. If not set, the default value is 'false'