Package org.opends.server.authorization.dseecompat

Class Aci

java.lang.Object

org.opends.server.authorization.dseecompat.Aci

All Implemented Interfaces:

Comparable<Aci>

public final class Aci
extends Object
implements Comparable<Aci>

The Aci class represents ACI strings.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SUPPORTED_VERSION	Version that we support.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Aci aci)	Compares this Aci with the provided Aci based on a natural order.
static Aci	decode(String aciString, Dn dn, ServerContext serverContext)	Decode an ACI byte string.
Dn	getDN()	Return the DN of the entry containing the ACI.
String	getName()	Returns the name string of this ACI.
AciTargets	getTargets()	Returns the targets of the ACI.
String	toString()	Return the string representation of the ACI.

Methods inherited from class java.lang.Object

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

Field Detail

SUPPORTED_VERSION

public static final String SUPPORTED_VERSION

Version that we support.

See Also:

Constant Field Values

Method Detail

decode

public static Aci decode(String aciString,
                         Dn dn,
                         ServerContext serverContext)
                  throws AciException

Decode an ACI byte string.

Parameters:

aciString - the ACI string.

dn - DN of the ACI entry.

serverContext - the server context

Returns:

Returns a decoded ACI representing the string argument.

Throws:

AciException - If the parsing of the ACI string fails.

toString

public String toString()

Return the string representation of the ACI. This was the string that was used to create the Aci class.

Overrides:

toString in class Object

Returns:

A string representation of the ACI.

getTargets

public AciTargets getTargets()

Returns the targets of the ACI.

Returns:

Any AciTargets of the ACI. There may be no targets so this might be null.

getDN

public Dn getDN()

Return the DN of the entry containing the ACI.

Returns:

The DN of the entry containing the ACI.

getName

public String getName()

Returns the name string of this ACI.

Returns:

The name string.

compareTo

public int compareTo(Aci aci)

Compares this Aci with the provided Aci based on a natural order. This order will be first hierarchical (ancestors will come before descendants) and then alphabetical by attribute name(s) and value(s).

Specified by:

compareTo in interface Comparable<Aci>

Parameters:

aci - The Aci against which to compare this Aci.

Returns:

A negative integer if this Aci should come before the provided Aci, a positive integer if this Aci should come after the provided Aci, or zero if there is no difference with regard to ordering.