ACI (OpenAM Project 15.1.7-SNAPSHOT API)

java.lang.Object
- com.iplanet.services.ldap.aci.ACI

```
public class ACI
extends Object
```
Class that encapsulates directory entry aci Provides a simple programmatic interface to compose, set, query and parse ACI

Field Summary

Fields
Modifier and Type Field and Description

static String ACI

Fields
Modifier and Type	Field and Description
`static String`	`ACI`

Constructor Summary

Constructors
Constructor and Description
`ACI()` No argument constructor
`ACI(String name)` Constructor
`ACI(String name, String target, String targetFilter, QualifiedCollection targetAttributes, Collection users, QualifiedCollection permissions)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object object)` Checks whether the object is passed is semantically equal to this object.
`String`	`getACIText()` Get the ACI text.
`Collection`	`getAttrRuleValue(String attrName)` Gets the collections of values for the given attrRuleName
`Collection`	`getAuthMethods()` Gets the authorization methods to which this ACI applies
`Collection`	`getClientHostNames()` Gets the client DNS host names to which this ACI applies
`Collection`	`getClientIP()` Gets the client IPs to which this ACI applies
`Collection`	`getDaysOfWeek()` Gets the days of the week on which this ACI applies
`Collection`	`getGroups()` Gets the collection of groups to whom the ACI apllies
`String`	`getName()` Gets the name of the ACI
`QualifiedCollection`	`getPermissions()` Geets the QualifiedCollection of permissions that apply to the ACI
`Collection`	`getRoles()` Gets the collection of roles to which the ACI applies
`Collection`	`getSupportedAttrRules()` Gets the names of supported attr rule names
`String`	`getTarget()` Gets the target of the ACI
`String`	`getTargetAttrFilters()` Gets the target attr filters that controls value based access control
`QualifiedCollection`	`getTargetAttributes()` Geets the QualifiedCollection of targetAttributes that apply to the ACI
`String`	`getTargetFilter()` Gets the target filter for the ACI
`Collection`	`getTimesOfDay()` Gets the times of the day at which this ACI applies
`Collection`	`getUserAttrs()` Get the user Attributes.
`Collection`	`getUserDNAttrs()` Get the DN attributes.
`Collection`	`getUsers()` Gets the collection of users to whom the ACI apllies
`String`	`getVersion()` Get the version number.
`void`	`removeTargetAttributes()` Removes the QualifiedCollection of targetAttributes that contol the attributes to which this ACI apllies
`void`	`removeTargetFilter()` Removes the target filter of the ACI
`void`	`setACIText(String aciText)` Set the ACI text.
`void`	`setACR(com.iplanet.services.ldap.aci.ACR acr)` Set the Access Control Rule.
`void`	`setAttrRuleValue(String attrName, Collection values)` Sets the value for the given attrRule name
`void`	`setAuthMethods(Collection authMethods)` Sets the authorization methods to which this ACI applies
`void`	`setClientHostNames(Collection clientHostNames)` Sets the client DNS host names to which this ACI applies
`void`	`setClientIP(Collection clientIP)` Sets the client IPs to which this ACI applies
`void`	`setDaysOfWeek(Collection daysOfWeek)` Sets the days of the week on which this ACI applies
`void`	`setGroupDNAttrs(Collection values)` Set the group DN attributes.
`void`	`setGroups(Collection groups)` Sets the collection of groups to whom the ACI apllies
`void`	`setName(String name)` Sets the name of the ACI
`void`	`setPermissions(QualifiedCollection permissions)` Sets the QualifiedCollection of permissions that apply to the ACI
`void`	`setRoles(Collection roles)` Sets the collection of roles to which the ACI applies
`void`	`setTarget(String target)` Sets the target of the ACI
`void`	`setTargetAttrFilters(String targetAttrFilters)` Sets the target attr filters that controls value based access control
`void`	`setTargetAttributes(QualifiedCollection targetAttributes)` Sets the QualifiedCollection of targetAttributes that apply to the ACI
`void`	`setTargetFilter(String targetFilter)` Sets the target filter of the ACI
`void`	`setTimesOfDay(Collection timesOfDay)` Sets the times of the day at which this ACI applies
`void`	`setUserAttrs(Collection values)` Set the user attributes.
`void`	`setUserDNAttrs(Collection values)` Set the user DN attributes
`void`	`setUsers(Collection users)` Sets the collection of users to whom the ACI apllies
`void`	`setVersion(String version)` Set the version number of the ACI.
`String`	`toString()` Gets a string representation of this ACI
`static ACI`	`valueOf(String aciText)` Converts aci text to ACI

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

- Field Detail
  - ACI
```
public static final String ACI
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ACI
```
public ACI()
```
    No argument constructor
  - ACI
```
public ACI(String name)
```
    Constructor
    
    Parameters:
    
    name - name of the ACI
  - ACI
```
public ACI(String name,
           String target,
           String targetFilter,
           QualifiedCollection targetAttributes,
           Collection users,
           QualifiedCollection permissions)
```
- Method Detail
  - equals
```
public boolean equals(Object object)
```
    Checks whether the object is passed is semantically equal to this object. The objects are considered to be equal if both the objects have the same state, that is their respective instance variables have equal values.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    object - the object to check for equality
    
    Returns:
    
    true if the passed object is equal to this object, false otherwise
  - setName
```
public void setName(String name)
```
    Sets the name of the ACI
    
    Parameters:
    
    name - the name of the ACI
  - getName
```
public String getName()
```
    Gets the name of the ACI
    
    Returns:
    
    the name of the ACI
  - setTarget
```
public void setTarget(String target)
```
    Sets the target of the ACI
    
    Parameters:
    
    target - the target of the ACI
  - getTarget
```
public String getTarget()
```
    Gets the target of the ACI
    
    Returns:
    
    the target of the ACI
  - setTargetFilter
```
public void setTargetFilter(String targetFilter)
```
    Sets the target filter of the ACI
    
    Parameters:
    
    targetFilter - the ldap target filter for the ACI
  - getTargetFilter
```
public String getTargetFilter()
```
    Gets the target filter for the ACI
    
    Returns:
    
    the target filter that controls the entries to which the ACI apllies
  - removeTargetFilter
```
public void removeTargetFilter()
```
    Removes the target filter of the ACI
  - setTargetAttributes
```
public void setTargetAttributes(QualifiedCollection targetAttributes)
```
    Sets the QualifiedCollection of targetAttributes that apply to the ACI
    
    Parameters:
    
    targetAttributes - the QualifiedCollection of target attributes that apply to the ACI
  - getTargetAttributes
```
public QualifiedCollection getTargetAttributes()
```
    Geets the QualifiedCollection of targetAttributes that apply to the ACI
    
    Returns:
    
    the QualifiedCollection of target attributes that apply to the ACI
  - removeTargetAttributes
```
public void removeTargetAttributes()
```
    Removes the QualifiedCollection of targetAttributes that contol the attributes to which this ACI apllies
  - setPermissions
```
public void setPermissions(QualifiedCollection permissions)
```
    Sets the QualifiedCollection of permissions that apply to the ACI
    
    Parameters:
    
    permissions - the QualifiedCollection of permissions that apply to the ACI
  - getPermissions
```
public QualifiedCollection getPermissions()
```
    Geets the QualifiedCollection of permissions that apply to the ACI
    
    Returns:
    
    the QualifiedCollection of permissions that apply to the ACI
  - setUsers
```
public void setUsers(Collection users)
```
    Sets the collection of users to whom the ACI apllies
    
    Parameters:
    
    users - the collection of users to whom the ACI apllies
  - getUsers
```
public Collection getUsers()
```
    Gets the collection of users to whom the ACI apllies
    
    Returns:
    
    the collection of users to whom the ACI apllies
  - setGroups
```
public void setGroups(Collection groups)
```
    Sets the collection of groups to whom the ACI apllies
    
    Parameters:
    
    groups - the collection of groups to whom the ACI apllies
  - getGroups
```
public Collection getGroups()
```
    Gets the collection of groups to whom the ACI apllies
    
    Returns:
    
    the collection of groups to whom the ACI apllies
  - setRoles
```
public void setRoles(Collection roles)
```
    Sets the collection of roles to which the ACI applies
    
    Parameters:
    
    roles - the collection of roles to which the ACI applies
  - getRoles
```
public Collection getRoles()
```
    Gets the collection of roles to which the ACI applies
    
    Returns:
    
    the collection of roles to which the ACI applies
  - setClientIP
```
public void setClientIP(Collection clientIP)
```
    Sets the client IPs to which this ACI applies
    
    Parameters:
    
    clientIP - collection of client IPs to which this ACI applies
  - getClientIP
```
public Collection getClientIP()
```
    Gets the client IPs to which this ACI applies
    
    Returns:
    
    collection of client IPs to which this ACI applies
  - setClientHostNames
```
public void setClientHostNames(Collection clientHostNames)
```
    Sets the client DNS host names to which this ACI applies
    
    Parameters:
    
    clientHostNames - collection of DNS host names to which this ACI applies
  - getClientHostNames
```
public Collection getClientHostNames()
```
    Gets the client DNS host names to which this ACI applies
    
    Returns:
    
    collection of DNS host names to which this ACI applies
  - setTimesOfDay
```
public void setTimesOfDay(Collection timesOfDay)
```
    Sets the times of the day at which this ACI applies
    
    Parameters:
    
    timesOfDay - collection of timesOfDay at which this ACI applies
  - getTimesOfDay
```
public Collection getTimesOfDay()
```
    Gets the times of the day at which this ACI applies
    
    Returns:
    
    collection of timesOfDay at which this ACI applies
  - setDaysOfWeek
```
public void setDaysOfWeek(Collection daysOfWeek)
```
    Sets the days of the week on which this ACI applies
    
    Parameters:
    
    daysOfWeek - collection of days of week on which this ACI applies
  - getDaysOfWeek
```
public Collection getDaysOfWeek()
```
    Gets the days of the week on which this ACI applies
    
    Returns:
    
    collection of days of week on which this ACI applies
  - setAuthMethods
```
public void setAuthMethods(Collection authMethods)
```
    Sets the authorization methods to which this ACI applies
    
    Parameters:
    
    authMethods - the collection of authorization methods to which this ACI applies
  - getAuthMethods
```
public Collection getAuthMethods()
```
    Gets the authorization methods to which this ACI applies
    
    Returns:
    
    collection of authorization methods to which this ACI applies
  - setAttrRuleValue
```
public void setAttrRuleValue(String attrName,
                             Collection values)
                      throws ACIComposeException
```
    Sets the value for the given attrRule name
    
    Parameters:
    
    attrName - name of the attribute
    
    values - collections of value for the attr rule
    
    Throws:
    
    ACIComposeException
  - getAttrRuleValue
```
public Collection getAttrRuleValue(String attrName)
                            throws ACIException
```
    Gets the collections of values for the given attrRuleName
    
    Returns:
    
    collection of attr rule names supported by the ACI API
    
    Throws:
    
    ACIException
  - getSupportedAttrRules
```
public Collection getSupportedAttrRules()
```
    Gets the names of supported attr rule names
    
    Returns:
    
    the collection of attr rule names supported by the ACI API
  - setTargetAttrFilters
```
public void setTargetAttrFilters(String targetAttrFilters)
```
    Sets the target attr filters that controls value based access control
    
    Parameters:
    
    targetAttrFilters - string defining a filter for value based access control
  - getTargetAttrFilters
```
public String getTargetAttrFilters()
```
    Gets the target attr filters that controls value based access control
    
    Returns:
    
    string defining a filter for value based access control
  - toString
```
public String toString()
```
    Gets a string representation of this ACI
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    string representation of this ACI
  - valueOf
```
public static ACI valueOf(String aciText)
                   throws ACIParseException
```
    Converts aci text to ACI
    
    Parameters:
    
    aciText - value of aci attribute, typically read from directoy server
    
    Returns:
    
    the converted ACI
    
    Throws:
    
    ACIParseException
  - setUserDNAttrs
```
public void setUserDNAttrs(Collection values)
```
    Set the user DN attributes
  - getUserDNAttrs
```
public Collection getUserDNAttrs()
```
    Get the DN attributes.
  - setGroupDNAttrs
```
public void setGroupDNAttrs(Collection values)
```
    Set the group DN attributes.
  - setUserAttrs
```
public void setUserAttrs(Collection values)
```
    Set the user attributes.
  - getUserAttrs
```
public Collection getUserAttrs()
```
    Get the user Attributes.
  - setACIText
```
public void setACIText(String aciText)
```
    Set the ACI text.
  - getACIText
```
public String getACIText()
```
    Get the ACI text.
  - setACR
```
public void setACR(com.iplanet.services.ldap.aci.ACR acr)
```
    Set the Access Control Rule.
  - setVersion
```
public void setVersion(String version)
```
    Set the version number of the ACI.
  - getVersion
```
public String getVersion()
```
    Get the version number.

Class ACI

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACI

Constructor Detail

ACI

ACI

ACI

Method Detail

equals

setName

getName

setTarget

getTarget

setTargetFilter

getTargetFilter

removeTargetFilter

setTargetAttributes

getTargetAttributes

removeTargetAttributes

setPermissions

getPermissions

setUsers

getUsers

setGroups

getGroups

setRoles

getRoles

setClientIP

getClientIP

setClientHostNames

getClientHostNames

setTimesOfDay

getTimesOfDay

setDaysOfWeek

getDaysOfWeek

setAuthMethods

getAuthMethods

setAttrRuleValue

getAttrRuleValue

getSupportedAttrRules

setTargetAttrFilters

getTargetAttrFilters

toString

valueOf

setUserDNAttrs

getUserDNAttrs

setGroupDNAttrs

setUserAttrs

getUserAttrs

setACIText

getACIText

setACR

setVersion

getVersion