public final class SubResourceCollection extends SubResource
Modifier and Type | Method and Description |
---|---|
SubResourceCollection |
dnTemplate(String dnTemplate)
Sets the relative DN template beneath which the sub-resource LDAP entries will be located.
|
SubResourceCollection |
glueObjectClass(String objectClass)
Specifies an LDAP object class which is to be associated with any intermediate "glue" entries forming the DN
template.
|
SubResourceCollection |
glueObjectClasses(String... objectClasses)
Specifies one or more LDAP object classes which is to be associated with any intermediate "glue" entries
forming the DN template.
|
SubResourceCollection |
isReadOnly(boolean readOnly)
Indicates whether this sub-resource collection only supports read and query operations.
|
SubResourceCollection |
urlTemplate(String urlTemplate)
Sets the relative URL template beneath which the sub-resources will be located.
|
SubResourceCollection |
useClientDnNaming(String dnAttribute)
Indicates that the JSON resource ID must be provided by the user, and will be used for naming the associated LDAP
entry.
|
SubResourceCollection |
useClientNaming(String dnAttribute,
String idAttribute)
Indicates that the JSON resource ID must be provided by the user, but will not be used for naming the
associated LDAP entry.
|
SubResourceCollection |
useServerEntryUuidNaming(String dnAttribute)
Indicates that the JSON resource ID will be derived from the server provided "entryUUID" LDAP attribute.
|
SubResourceCollection |
useServerNaming(String dnAttribute,
String idAttribute)
Indicates that the JSON resource ID must not be provided by the user, and will not be used for naming the
associated LDAP entry.
|
equals, hashCode, toString
public SubResourceCollection useClientDnNaming(String dnAttribute)
Note that this naming policy requires that the user provides the resource name when creating new resources, which means it must be included in the resource content when not specified explicitly in the create request.
dnAttribute
- The LDAP attribute which will be used for naming.public SubResourceCollection useClientNaming(String dnAttribute, String idAttribute)
idAttribute
in the LDAP
entry, and the LDAP entry name will be derived by appending a single RDN to the collection's base DN composed
of the dnAttribute
taken from the LDAP entry once attribute mapping has been performed.
Note that this naming policy requires that the user provides the resource name when creating new resources, which means it must be included in the resource content when not specified explicitly in the create request.
dnAttribute
- The attribute which will be used for naming LDAP entries.idAttribute
- The attribute which will be used for JSON resource IDs.public SubResourceCollection useServerEntryUuidNaming(String dnAttribute)
dnAttribute
taken from the LDAP entry once attribute mapping has been performed.
Note that this naming policy requires that the server provides the resource name when creating new resources, which means it must not be specified in the create request, nor included in the resource content.
dnAttribute
- The attribute which will be used for naming LDAP entries.public SubResourceCollection useServerNaming(String dnAttribute, String idAttribute)
idAttribute
in the LDAP
entry, and the LDAP entry name will be derived by appending a single RDN to the collection's base DN composed
of the dnAttribute
taken from the LDAP entry once attribute mapping has been performed.
Note that this naming policy requires that the server provides the resource name when creating new resources, which means it must not be specified in the create request, nor included in the resource content.
dnAttribute
- The attribute which will be used for naming LDAP entries.idAttribute
- The attribute which will be used for JSON resource IDs.public SubResourceCollection urlTemplate(String urlTemplate)
DN template
.urlTemplate
- The relative URL template.public SubResourceCollection dnTemplate(String dnTemplate)
URL template
.dnTemplate
- The relative DN template.public SubResourceCollection glueObjectClass(String objectClass)
objectClass
- An LDAP object class which is to be associated with any intermediate "glue" entries forming the DN
template.public SubResourceCollection glueObjectClasses(String... objectClasses)
objectClasses
- The LDAP object classes which is to be associated with any intermediate "glue" entries forming the DN
template.public SubResourceCollection isReadOnly(boolean readOnly)
readOnly
- true
if this sub-resource collection is read-only.Copyright 2010-2018 ForgeRock AS.