ACE (ADSDDL 1.9 API)

java.lang.Object
- net.tirasa.adsddl.ntsd.ACE

```
public class ACE
extends java.lang.Object
```
An access control entry (ACE) is used to encode the user rights afforded to a principal, either a user or group. This is generally done by combining an ACCESS_MASK and the SID of the principal.

Field Summary

Fields
Modifier and Type Field and Description

protected static org.slf4j.Logger LOG
Logger.

Fields
Modifier and Type	Field and Description
`protected static org.slf4j.Logger`	`LOG` Logger.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFlag(AceFlag flag)` Adds ACE flag.
`boolean`	`equals(java.lang.Object ace)`
`byte[]`	`getApplicationData()` Optional application data.
`java.util.List<AceFlag>`	`getFlags()` Gets ACE flags.
`byte[]`	`getInheritedObjectType()` A GUID (16 bytes) that identifies the type of child object that can inherit the ACE.
`AceObjectFlags`	`getObjectFlags()` A 32-bit unsigned integer that specifies a set of bit flags that indicate whether the ObjectType and InheritedObjectType fields contain valid data.
`byte[]`	`getObjectType()` A GUID (16 bytes) that identifies a property set, property, extended right, or type of child object.
`AceRights`	`getRights()` An ACCESS_MASK that specifies the user rights allowed by this ACE.
`SID`	`getSid()` The SID of a trustee.
`int`	`getSize()` An unsigned 16-bit integer that specifies the size, in bytes, of the ACE.
`AceType`	`getType()` Gets ACE type.
`int`	`hashCode()`
`static ACE`	`newInstance(AceType type)` Creates a new ACE instance.
`void`	`setApplicationData(byte[] applicationData)` Sets application data.
`void`	`setInheritedObjectType(byte[] inheritedObjectType)` Sets inherited object type, a GUID (16 bytes) that identifies the type of child object that can inherit the ACE.
`void`	`setObjectFlags(AceObjectFlags objectFlags)` Sets object flags.
`void`	`setObjectType(byte[] objectType)` Sets object type, a GUID (16 bytes) that identifies a property set, property, extended right, or type of child object.
`void`	`setRights(AceRights rights)` Sets ACE rights.
`void`	`setSid(SID sid)` Sets the SID of a trustee.
`void`	`setType(AceType type)` Sets ACE type.
`byte[]`	`toByteArray()` Serializes to byte array.
`java.lang.String`	`toString()` Serializes to string.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - LOG
```
protected static final org.slf4j.Logger LOG
```
    Logger.
- Method Detail
  - newInstance
```
public static ACE newInstance(AceType type)
```
    Creates a new ACE instance.
    
    Parameters:
    
    type - ACE type.
    
    Returns:
    
    ACE.
  - getType
```
public AceType getType()
```
    Gets ACE type.
    
    Returns:
    
    ACE type.
    
    See Also:
    
    AceType
  - getFlags
```
public java.util.List<AceFlag> getFlags()
```
    Gets ACE flags.
    
    Returns:
    
    ACE flags; empty list if no flag has been specified.
    
    See Also:
    
    AceFlag
  - getApplicationData
```
public byte[] getApplicationData()
```
    Optional application data. The size of the application data is determined by the AceSize field.
    
    Returns:
    
    application data; null if not available.
  - setApplicationData
```
public void setApplicationData(byte[] applicationData)
```
    Sets application data.
    
    Parameters:
    
    applicationData - application data.
  - getRights
```
public AceRights getRights()
```
    An ACCESS_MASK that specifies the user rights allowed by this ACE.
    
    Returns:
    
    ACE rights.
    
    See Also:
    
    AceRights
  - getObjectFlags
```
public AceObjectFlags getObjectFlags()
```
    A 32-bit unsigned integer that specifies a set of bit flags that indicate whether the ObjectType and InheritedObjectType fields contain valid data. This parameter can be one or more of the following values.
    
    Returns:
    
    Flags.
    
    See Also:
    
    AceObjectFlags
  - getObjectType
```
public byte[] getObjectType()
```
    A GUID (16 bytes) that identifies a property set, property, extended right, or type of child object. The purpose of this GUID depends on the user rights specified in the Mask field. This field is valid only if the ACE _OBJECT_TYPE_PRESENT bit is set in the Flags field. Otherwise, the ObjectType field is ignored. For information on access rights and for a mapping of the control access rights to the corresponding GUID value that identifies each right, see [MS-ADTS] sections 5.1.3.2 and 5.1.3.2.1. ACCESS_MASK bits are not mutually exclusive. Therefore, the ObjectType field can be set in an ACE with any ACCESS_MASK. If the AccessCheck algorithm calls this ACE and does not find an appropriate GUID, then that ACE will be ignored. For more information on access checks and object access, see [MS-ADTS] section 5.1.3.3.3.
    
    Returns:
    
    ObjectType; null if not available.
  - getInheritedObjectType
```
public byte[] getInheritedObjectType()
```
    A GUID (16 bytes) that identifies the type of child object that can inherit the ACE. Inheritance is also controlled by the inheritance flags in the ACE_HEADER, as well as by any protection against inheritance placed on the child objects. This field is valid only if the ACE_INHERITED_OBJECT_TYPE_PRESENT bit is set in the Flags member. Otherwise, the InheritedObjectType field is ignored.
    
    Returns:
    
    InheritedObjectType; null if not available.
  - getSid
```
public SID getSid()
```
    The SID of a trustee. The length of the SID MUST be a multiple of 4.
    
    Returns:
    
    SID of the trustee.
    
    See Also:
    
    SID
  - getSize
```
public int getSize()
```
    An unsigned 16-bit integer that specifies the size, in bytes, of the ACE. The AceSize field can be greater than the sum of the individual fields, but MUST be a multiple of 4 to ensure alignment on a DWORD boundary. In cases where the AceSize field encompasses additional data for the callback ACEs types, that data is implementation-specific. Otherwise, this additional data is not interpreted and MUST be ignored.
    
    Returns:
    
    ACE size.
  - setType
```
public void setType(AceType type)
```
    Sets ACE type.
    
    Parameters:
    
    type - ACE type.
    
    See Also:
    
    AceType
  - addFlag
```
public void addFlag(AceFlag flag)
```
    Adds ACE flag.
    
    Parameters:
    
    flag - ACE flag.
    
    See Also:
    
    AceFlag
  - setRights
```
public void setRights(AceRights rights)
```
    Sets ACE rights.
    
    Parameters:
    
    rights - ACE rights.
    
    See Also:
    
    AceRights
  - setObjectFlags
```
public void setObjectFlags(AceObjectFlags objectFlags)
```
    Sets object flags.
    
    Parameters:
    
    objectFlags - ACE object flags.
    
    See Also:
    
    AceObjectFlags
  - setObjectType
```
public void setObjectType(byte[] objectType)
```
    Sets object type, a GUID (16 bytes) that identifies a property set, property, extended right, or type of child object.
    
    Parameters:
    
    objectType - ACE object type.
  - setInheritedObjectType
```
public void setInheritedObjectType(byte[] inheritedObjectType)
```
    Sets inherited object type, a GUID (16 bytes) that identifies the type of child object that can inherit the ACE.
    
    Parameters:
    
    inheritedObjectType - Inherited object type.
  - setSid
```
public void setSid(SID sid)
```
    Sets the SID of a trustee.
    
    Parameters:
    
    sid - SID of the trustee.
    
    See Also:
    
    SID
  - toByteArray
```
public byte[] toByteArray()
```
    Serializes to byte array.
    
    Returns:
    
    serialized ACE.
  - equals
```
public boolean equals(java.lang.Object ace)
```
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    ace - ACE to be compared with.
    
    Returns:
    
    true if equals; false otherwise.
  - toString
```
public java.lang.String toString()
```
    Serializes to string.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    serialized ACE.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    hashcode.

Class ACE

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

Method Detail

newInstance

getType

getFlags

getApplicationData

setApplicationData

getRights

getObjectFlags

getObjectType

getInheritedObjectType

getSid

getSize

setType

addFlag

setRights

setObjectFlags

setObjectType

setInheritedObjectType

setSid

toByteArray

equals

toString

hashCode