Package org.forgerock.opendj.rest2ldap

Class SubResourceSingleton

java.lang.Object

org.forgerock.opendj.rest2ldap.SubResource

org.forgerock.opendj.rest2ldap.SubResourceSingleton

public final class SubResourceSingleton
extends SubResource

Represents a one to one relationship between a parent resource and a child sub-resource. Removal of the parent resource implies that the child (the sub-resource) is also removed. Singletons only support read, update, patch, and action requests.

Method Summary

Modifier and Type	Method	Description
SubResourceSingleton	dnTemplate(String dnTemplate)	Sets the relative DN template of the single sub-resource LDAP entry.
SubResourceSingleton	isReadOnly(boolean readOnly)	Indicates whether this sub-resource singleton only supports read operations.
SubResourceSingleton	urlTemplate(String urlTemplate)	Sets the relative URL template of the single sub-resource.

Methods inherited from class org.forgerock.opendj.rest2ldap.SubResource

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

urlTemplate

public SubResourceSingleton urlTemplate(String urlTemplate)

Sets the relative URL template of the single sub-resource. The template must comprise of at least one path element. Any URL template variables will be substituted into the DN template.

Parameters:

urlTemplate - The relative URL template.

Returns:

A reference to this object.

dnTemplate

public SubResourceSingleton dnTemplate(String dnTemplate)

Sets the relative DN template of the single sub-resource LDAP entry. The template must comprise of at least one RDN. Any DN template variables will be substituted using values extracted from the URL template.

Parameters:

dnTemplate - The relative DN template.

Returns:

A reference to this object.

isReadOnly

public SubResourceSingleton isReadOnly(boolean readOnly)

Indicates whether this sub-resource singleton only supports read operations.

Parameters:

readOnly - true if this sub-resource singleton is read-only.

Returns:

A reference to this object.