* The supported options are defined in this class.
*
* @param options The configuration options for interactions with the backend LDAP server. The set of available
* options are provided in this class.
* @param resources The list of resources.
* @return A new Rest2Ldap instance from which REST request handlers can be obtained.
*/
public static Rest2Ldap rest2Ldap(final Options options, final Collection
* The supported options are defined in this class.
*
* @param options The configuration options for interactions with the backend LDAP server. The set of available
* options are provided in this class.
* @param resources The list of resources.
* @return A new Rest2Ldap instance from which REST request handlers can be obtained.
*/
public static Rest2Ldap rest2Ldap(final Options options, final Resource... resources) {
return rest2Ldap(options, Arrays.asList(resources));
}
/**
* Creates a new {@link Resource resource} definition with the provided resource ID.
*
* @param resourceId
* The resource ID.
* @return A new resource definition with the provided resource ID.
*/
public static Resource resource(final String resourceId) {
return new Resource(resourceId);
}
/**
* Creates a new {@link SubResourceCollection collection} sub-resource definition whose members will be resources
* having the provided resource ID or its sub-types.
*
* @param resourceId
* The type of resource contained in the sub-resource collection.
* @return A new sub-resource definition with the provided resource ID.
*/
public static SubResourceCollection collectionOf(final String resourceId) {
return new SubResourceCollection(resourceId);
}
/**
* Creates a new {@link SubResourceSingleton singleton} sub-resource definition which will reference a single
* resource having the specified resource ID.
*
* @param resourceId
* The type of resource referenced by the sub-resource singleton.
* @return A new sub-resource definition with the provided resource ID.
*/
public static SubResourceSingleton singletonOf(final String resourceId) {
return new SubResourceSingleton(resourceId);
}
/**
* Returns a property mapper which maps a JSON property containing the resource type to its associated LDAP
* object classes.
*
* @return The property mapper.
*/
public static PropertyMapper resourceType() {
return ResourceTypePropertyMapper.INSTANCE;
}
/**
* Returns a property mapper which maps a single JSON attribute to a JSON constant.
*
* @param value
* The constant JSON value (a Boolean, Number, String, Map, or List).
* @return The property mapper.
*/
public static PropertyMapper constant(final Object value) {
return new JsonConstantPropertyMapper(value);
}
/**
* Returns a property mapper which maps JSON objects to LDAP attributes.
*
* @return The property mapper.
*/
public static ObjectPropertyMapper object() {
return new ObjectPropertyMapper();
}
/**
* Returns a property mapper which provides a mapping from a JSON value to a single DN valued LDAP attribute.
*
* @param attribute
* The DN valued LDAP attribute to be mapped.
* @param baseDnTemplate
* The DN template which will be used as the search base when performing reverse lookups. The DN template
* may include template parameters and also parent RDNs using ".." notation. For example, the DN template
* "ou=groups,..,.." specifies that the search base DN should be computed by appending the RDN
* "ou=groups" to the grand-parent of the current resource's LDAP entry.
* @param primaryKey
* The search primary key LDAP attribute to use for performing reverse lookups.
* @param mapper
* An property mapper which will be used to map LDAP attributes in the referenced entry.
* @return The property mapper.
*/
public static ReferencePropertyMapper reference(final AttributeDescription attribute, final String baseDnTemplate,
final AttributeDescription primaryKey,
final PropertyMapper mapper) {
return new ReferencePropertyMapper(Schema.getDefaultSchema(), attribute, baseDnTemplate, primaryKey, mapper);
}
/**
* Returns a property mapper which provides a mapping from a JSON value to a single DN valued LDAP attribute.
*
* @param attribute
* The DN valued LDAP attribute to be mapped.
* @param baseDnTemplate
* The DN template which will be used as the search base when performing reverse lookups. The DN template
* may include template parameters and also parent RDNs using ".." notation. For example, the DN template
* "ou=groups,..,.." specifies that the search base DN should be computed by appending the RDN
* "ou=groups" to the grand-parent of the current resource's LDAP entry.
* @param primaryKey
* The search primary key LDAP attribute to use for performing reverse lookups.
* @param mapper
* An property mapper which will be used to map LDAP attributes in the referenced entry.
* @return The property mapper.
*/
public static ReferencePropertyMapper reference(final String attribute, final String baseDnTemplate,
final String primaryKey, final PropertyMapper mapper) {
return reference(AttributeDescription.valueOf(attribute),
baseDnTemplate,
AttributeDescription.valueOf(primaryKey),
mapper);
}
/**
* Returns a property mapper which provides a simple mapping from a JSON value to a single LDAP attribute.
*
* @param attribute
* The LDAP attribute to be mapped.
* @return The property mapper.
*/
public static SimplePropertyMapper simple(final AttributeDescription attribute) {
return new SimplePropertyMapper(attribute);
}
/**
* Returns a property mapper which provides a simple mapping from a JSON value to a single LDAP attribute.
*
* @param attribute
* The LDAP attribute to be mapped.
* @return The property mapper.
*/
public static SimplePropertyMapper simple(final String attribute) {
return simple(AttributeDescription.valueOf(attribute));
}
/**
* Adapts a {@code Throwable} to a {@code ResourceException}. If the {@code Throwable} is an LDAP
* {@link LdapException} then an appropriate {@code ResourceException} is returned, otherwise an {@code
* InternalServerErrorException} is returned.
* @param t
* The {@code Throwable} to be converted.
* @return The equivalent resource exception.
*/
public static ResourceException asResourceException(final Throwable t) {
try {
throw t;
} catch (final ResourceException e) {
return e;
} catch (final AssertionFailureException e) {
return new PreconditionFailedException(e);
} catch (final ConstraintViolationException e) {
final ResultCode rc = e.getResult().getResultCode();
if (rc.equals(ENTRY_ALREADY_EXISTS)) {
return new PreconditionFailedException(e); // Consistent with MVCC.
} else {
return new BadRequestException(e); // Schema violation, etc.
}
} catch (final AuthenticationException e) {
return new PermanentException(401, null, e); // Unauthorized
} catch (final AuthorizationException e) {
return new ForbiddenException(e);
} catch (final ConnectionException e) {
return new ServiceUnavailableException(e);
} catch (final EntryNotFoundException e) {
return new NotFoundException(e);
} catch (final MultipleEntriesFoundException e) {
return new InternalServerErrorException(e);
} catch (final TimeoutResultException e) {
return new RetryableException(408, null, e); // Request Timeout
} catch (final LdapException e) {
final ResultCode rc = e.getResult().getResultCode();
if (rc.equals(ADMIN_LIMIT_EXCEEDED) || rc.equals(SIZE_LIMIT_EXCEEDED)) {
return new PermanentException(413, null, e); // Payload Too Large (Request Entity Too Large)
} else {
return new InternalServerErrorException(e);
}
} catch (final Throwable tmp) {
return new InternalServerErrorException(t);
}
}
private final Map