public interface GlobalAccessControlPolicyCfgClient extends ConfigurationClient
Provides coarse grained access control for all operations, regardless of whether they are destined for local or proxy backends. Global access control policies are applied in addition to ACIs and privileges.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends GlobalAccessControlPolicyCfgClient,? extends GlobalAccessControlPolicyCfg> |
definition()
Get the configuration definition associated with this Global Access Control Policy.
|
SortedSet<ValueOrExpression<String>> |
getAllowedAttribute()
Gets the "allowed-attribute" property.
|
SortedSet<ValueOrExpression<String>> |
getAllowedAttributeException()
Gets the "allowed-attribute-exception" property.
|
SortedSet<ValueOrExpression<String>> |
getAllowedControl()
Gets the "allowed-control" property.
|
SortedSet<ValueOrExpression<String>> |
getAllowedExtendedOperation()
Gets the "allowed-extended-operation" property.
|
SortedSet<ValueOrExpression<AddressMask>> |
getConnectionClientAddressEqualTo()
Gets the "connection-client-address-equal-to" property.
|
SortedSet<ValueOrExpression<AddressMask>> |
getConnectionClientAddressNotEqualTo()
Gets the "connection-client-address-not-equal-to" property.
|
ValueOrExpression<Integer> |
getConnectionMinimumSsf()
Gets the "connection-minimum-ssf" property.
|
SortedSet<ValueOrExpression<Integer>> |
getConnectionPortEqualTo()
Gets the "connection-port-equal-to" property.
|
SortedSet<ValueOrExpression<String>> |
getConnectionProtocolEqualTo()
Gets the "connection-protocol-equal-to" property.
|
SortedSet<ValueOrExpression<GlobalAccessControlPolicyCfgDefn.Permission>> |
getPermission()
Gets the "permission" property.
|
SortedSet<ValueOrExpression<String>> |
getRequestTargetDnEqualTo()
Gets the "request-target-dn-equal-to" property.
|
SortedSet<ValueOrExpression<String>> |
getRequestTargetDnNotEqualTo()
Gets the "request-target-dn-not-equal-to" property.
|
SortedSet<ValueOrExpression<String>> |
getUserDnEqualTo()
Gets the "user-dn-equal-to" property.
|
SortedSet<ValueOrExpression<String>> |
getUserDnNotEqualTo()
Gets the "user-dn-not-equal-to" property.
|
ValueOrExpression<Boolean> |
isAuthenticationRequired()
Gets the "authentication-required" property.
|
ValueOrExpression<Boolean> |
isRequestTargetDnEqualToUserDn()
Gets the "request-target-dn-equal-to-user-dn" property.
|
void |
setAllowedAttribute(Collection<ValueOrExpression<String>> values)
Sets the "allowed-attribute" property.
|
void |
setAllowedAttributeException(Collection<ValueOrExpression<String>> values)
Sets the "allowed-attribute-exception" property.
|
void |
setAllowedControl(Collection<ValueOrExpression<String>> values)
Sets the "allowed-control" property.
|
void |
setAllowedExtendedOperation(Collection<ValueOrExpression<String>> values)
Sets the "allowed-extended-operation" property.
|
void |
setAuthenticationRequired(ValueOrExpression<Boolean> value)
Sets the "authentication-required" property.
|
void |
setConnectionClientAddressEqualTo(Collection<ValueOrExpression<AddressMask>> values)
Sets the "connection-client-address-equal-to" property.
|
void |
setConnectionClientAddressNotEqualTo(Collection<ValueOrExpression<AddressMask>> values)
Sets the "connection-client-address-not-equal-to" property.
|
void |
setConnectionMinimumSsf(ValueOrExpression<Integer> value)
Sets the "connection-minimum-ssf" property.
|
void |
setConnectionPortEqualTo(Collection<ValueOrExpression<Integer>> values)
Sets the "connection-port-equal-to" property.
|
void |
setConnectionProtocolEqualTo(Collection<ValueOrExpression<String>> values)
Sets the "connection-protocol-equal-to" property.
|
void |
setPermission(Collection<ValueOrExpression<GlobalAccessControlPolicyCfgDefn.Permission>> values)
Sets the "permission" property.
|
void |
setRequestTargetDnEqualTo(Collection<ValueOrExpression<String>> values)
Sets the "request-target-dn-equal-to" property.
|
void |
setRequestTargetDnEqualToUserDn(ValueOrExpression<Boolean> value)
Sets the "request-target-dn-equal-to-user-dn" property.
|
void |
setRequestTargetDnNotEqualTo(Collection<ValueOrExpression<String>> values)
Sets the "request-target-dn-not-equal-to" property.
|
void |
setUserDnEqualTo(Collection<ValueOrExpression<String>> values)
Sets the "user-dn-equal-to" property.
|
void |
setUserDnNotEqualTo(Collection<ValueOrExpression<String>> values)
Sets the "user-dn-not-equal-to" property.
|
commit, properties
ManagedObjectDefinition<? extends GlobalAccessControlPolicyCfgClient,? extends GlobalAccessControlPolicyCfg> definition()
definition
in interface ConfigurationClient
SortedSet<ValueOrExpression<String>> getAllowedAttribute()
Allows clients to read or write the specified attributes, along with their sub-types.
Attributes that are subtypes of listed attributes are implicitly included. In addition, the list of attributes may include the wild-card '*', which represents all user attributes, or the wild-card '+', which represents all operational attributes, or the name of an object class prefixed with '@' to include all attributes defined by the object class.
void setAllowedAttribute(Collection<ValueOrExpression<String>> values) throws PropertyException
Allows clients to read or write the specified attributes, along with their sub-types.
Attributes that are subtypes of listed attributes are implicitly included. In addition, the list of attributes may include the wild-card '*', which represents all user attributes, or the wild-card '+', which represents all operational attributes, or the name of an object class prefixed with '@' to include all attributes defined by the object class.
values
- The values of the "allowed-attribute" property.PropertyException
- If one or more of the new values are invalid.SortedSet<ValueOrExpression<String>> getAllowedAttributeException()
Specifies zero or more attributes which, together with their sub-types, should not be included in the list of allowed attributes.
This property is typically used when the list of attributes specified by the allowed-attribute property is too broad. It is especially useful when creating policies which grant access to all user attributes (*) except certain sensitive attributes, such as userPassword.
void setAllowedAttributeException(Collection<ValueOrExpression<String>> values) throws PropertyException
Specifies zero or more attributes which, together with their sub-types, should not be included in the list of allowed attributes.
This property is typically used when the list of attributes specified by the allowed-attribute property is too broad. It is especially useful when creating policies which grant access to all user attributes (*) except certain sensitive attributes, such as userPassword.
values
- The values of the "allowed-attribute-exception" property.PropertyException
- If one or more of the new values are invalid.SortedSet<ValueOrExpression<String>> getAllowedControl()
Allows clients to use the specified LDAP controls.
void setAllowedControl(Collection<ValueOrExpression<String>> values) throws PropertyException
Allows clients to use the specified LDAP controls.
values
- The values of the "allowed-control" property.PropertyException
- If one or more of the new values are invalid.SortedSet<ValueOrExpression<String>> getAllowedExtendedOperation()
Allows clients to use the specified LDAP extended operations.
void setAllowedExtendedOperation(Collection<ValueOrExpression<String>> values) throws PropertyException
Allows clients to use the specified LDAP extended operations.
values
- The values of the "allowed-extended-operation" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<Boolean> isAuthenticationRequired()
Restricts the scope of the policy so that it only applies to authenticated users.
void setAuthenticationRequired(ValueOrExpression<Boolean> value) throws PropertyException
Restricts the scope of the policy so that it only applies to authenticated users.
value
- The value of the "authentication-required" property.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<AddressMask>> getConnectionClientAddressEqualTo()
Restricts the scope of the policy so that it only applies to connections which match at least one of the specified client host names or address masks.
Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a sub-network with sub-network mask.
void setConnectionClientAddressEqualTo(Collection<ValueOrExpression<AddressMask>> values) throws PropertyException
Restricts the scope of the policy so that it only applies to connections which match at least one of the specified client host names or address masks.
Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a sub-network with sub-network mask.
values
- The values of the "connection-client-address-equal-to" property.PropertyException
- If one or more of the new values are invalid.SortedSet<ValueOrExpression<AddressMask>> getConnectionClientAddressNotEqualTo()
Restricts the scope of the policy so that it only applies to connections which match none of the specified client host names or address masks.
Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a sub-network with sub-network mask.
void setConnectionClientAddressNotEqualTo(Collection<ValueOrExpression<AddressMask>> values) throws PropertyException
Restricts the scope of the policy so that it only applies to connections which match none of the specified client host names or address masks.
Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a sub-network with sub-network mask.
values
- The values of the "connection-client-address-not-equal-to" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<Integer> getConnectionMinimumSsf()
Restricts the scope of the policy so that it only applies to connections having the specified minimum security strength factor.
The security strength factor (ssf) pertains to the cipher key strength for connections using DIGEST-MD5, GSSAPI, SSL, or TLS. For example, to require that the connection must have a cipher strength of at least 256 bits, specify a value of 256.
void setConnectionMinimumSsf(ValueOrExpression<Integer> value) throws PropertyException
Restricts the scope of the policy so that it only applies to connections having the specified minimum security strength factor.
The security strength factor (ssf) pertains to the cipher key strength for connections using DIGEST-MD5, GSSAPI, SSL, or TLS. For example, to require that the connection must have a cipher strength of at least 256 bits, specify a value of 256.
value
- The value of the "connection-minimum-ssf" property.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<Integer>> getConnectionPortEqualTo()
Restricts the scope of the policy so that it only applies to connections to any of the specified ports, for example 1389.
void setConnectionPortEqualTo(Collection<ValueOrExpression<Integer>> values) throws PropertyException
Restricts the scope of the policy so that it only applies to connections to any of the specified ports, for example 1389.
values
- The values of the "connection-port-equal-to" property.PropertyException
- If one or more of the new values are invalid.SortedSet<ValueOrExpression<String>> getConnectionProtocolEqualTo()
Restricts the scope of the policy so that it only applies to connections which match any of the specified protocols.
void setConnectionProtocolEqualTo(Collection<ValueOrExpression<String>> values) throws PropertyException
Restricts the scope of the policy so that it only applies to connections which match any of the specified protocols.
values
- The values of the "connection-protocol-equal-to" property.PropertyException
- If one or more of the new values are invalid.SortedSet<ValueOrExpression<GlobalAccessControlPolicyCfgDefn.Permission>> getPermission()
Specifies the type of access allowed by this policy.
void setPermission(Collection<ValueOrExpression<GlobalAccessControlPolicyCfgDefn.Permission>> values) throws PropertyException
Specifies the type of access allowed by this policy.
values
- The values of the "permission" property.PropertyException
- If one or more of the new values are invalid.SortedSet<ValueOrExpression<String>> getRequestTargetDnEqualTo()
Restricts the scope of the policy so that it only applies to requests which target entries matching at least one of the specified DN patterns.
Valid DN filters are strings composed of zero or more wildcards and RDN components. A double wildcard ** replaces one or more RDN components (as in uid=dmiller,**,dc=example,dc=com). A simple wildcard * replaces either a whole RDN, or a whole type, or a value substring (as in uid=bj*,ou=people,dc=example,dc=com).
void setRequestTargetDnEqualTo(Collection<ValueOrExpression<String>> values) throws PropertyException
Restricts the scope of the policy so that it only applies to requests which target entries matching at least one of the specified DN patterns.
Valid DN filters are strings composed of zero or more wildcards and RDN components. A double wildcard ** replaces one or more RDN components (as in uid=dmiller,**,dc=example,dc=com). A simple wildcard * replaces either a whole RDN, or a whole type, or a value substring (as in uid=bj*,ou=people,dc=example,dc=com).
values
- The values of the "request-target-dn-equal-to" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<Boolean> isRequestTargetDnEqualToUserDn()
Restricts the scope of the policy so that it only applies to requests sent by authenticated users where the request's target DN is the same as the DN of the authorized user.
void setRequestTargetDnEqualToUserDn(ValueOrExpression<Boolean> value) throws PropertyException
Restricts the scope of the policy so that it only applies to requests sent by authenticated users where the request's target DN is the same as the DN of the authorized user.
value
- The value of the "request-target-dn-equal-to-user-dn" property.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<String>> getRequestTargetDnNotEqualTo()
Restricts the scope of the policy so that it only applies to requests which target entries matching none of the specified DN patterns.
Valid DN filters are strings composed of zero or more wildcards and RDN components. A double wildcard ** replaces one or more RDN components (as in uid=dmiller,**,dc=example,dc=com). A simple wildcard * replaces either a whole RDN, or a whole type, or a value substring (as in uid=bj*,ou=people,dc=example,dc=com).
void setRequestTargetDnNotEqualTo(Collection<ValueOrExpression<String>> values) throws PropertyException
Restricts the scope of the policy so that it only applies to requests which target entries matching none of the specified DN patterns.
Valid DN filters are strings composed of zero or more wildcards and RDN components. A double wildcard ** replaces one or more RDN components (as in uid=dmiller,**,dc=example,dc=com). A simple wildcard * replaces either a whole RDN, or a whole type, or a value substring (as in uid=bj*,ou=people,dc=example,dc=com).
values
- The values of the "request-target-dn-not-equal-to" property.PropertyException
- If one or more of the new values are invalid.SortedSet<ValueOrExpression<String>> getUserDnEqualTo()
Restricts the scope of the policy so that it only applies to authenticated users whose authorization DN matches at least one of the specified DN patterns.
Valid DN filters are strings composed of zero or more wildcards and RDN components. A double wildcard ** replaces one or more RDN components (as in uid=dmiller,**,dc=example,dc=com). A simple wildcard * replaces either a whole RDN, or a whole type, or a value substring (as in uid=bj*,ou=people,dc=example,dc=com).
void setUserDnEqualTo(Collection<ValueOrExpression<String>> values) throws PropertyException
Restricts the scope of the policy so that it only applies to authenticated users whose authorization DN matches at least one of the specified DN patterns.
Valid DN filters are strings composed of zero or more wildcards and RDN components. A double wildcard ** replaces one or more RDN components (as in uid=dmiller,**,dc=example,dc=com). A simple wildcard * replaces either a whole RDN, or a whole type, or a value substring (as in uid=bj*,ou=people,dc=example,dc=com).
values
- The values of the "user-dn-equal-to" property.PropertyException
- If one or more of the new values are invalid.SortedSet<ValueOrExpression<String>> getUserDnNotEqualTo()
Restricts the scope of the policy so that it only applies to authenticated users whose authorization DN matches none of the specified DN patterns.
Valid DN filters are strings composed of zero or more wildcards and RDN components. A double wildcard ** replaces one or more RDN components (as in uid=dmiller,**,dc=example,dc=com). A simple wildcard * replaces either a whole RDN, or a whole type, or a value substring (as in uid=bj*,ou=people,dc=example,dc=com).
void setUserDnNotEqualTo(Collection<ValueOrExpression<String>> values) throws PropertyException
Restricts the scope of the policy so that it only applies to authenticated users whose authorization DN matches none of the specified DN patterns.
Valid DN filters are strings composed of zero or more wildcards and RDN components. A double wildcard ** replaces one or more RDN components (as in uid=dmiller,**,dc=example,dc=com). A simple wildcard * replaces either a whole RDN, or a whole type, or a value substring (as in uid=bj*,ou=people,dc=example,dc=com).
values
- The values of the "user-dn-not-equal-to" property.PropertyException
- If one or more of the new values are invalid.Copyright 2010-2018 ForgeRock AS.