@Path(value="resources") public interface ResourceService extends JAXRSService
CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER
Modifier and Type | Method and Description |
---|---|
void |
check(@NotNull ResourceTO resourceTO)
Checks whether the connection to resource could be established.
|
javax.ws.rs.core.Response |
create(@NotNull ResourceTO resourceTO)
Creates a new resource.
|
void |
delete(@NotNull String key)
Deletes the resource matching the given name.
|
javax.ws.rs.core.Response |
getConnObjectKeyValue(@NotNull String key,
@NotNull String anyTypeKey,
@NotNull String anyKey)
Returns the calculated connObjectKey value for the given type and key.
|
List<ResourceTO> |
list()
Returns a list of all resources.
|
ResourceTO |
read(@NotNull String key)
Returns the resource with matching name.
|
ConnObjectTO |
readConnObject(@NotNull String key,
@NotNull String anyTypeKey,
@NotNull String value)
Returns connector object from the external resource, for the given type and key.
|
void |
removeSyncToken(@NotNull String key,
@NotNull String anyTypeKey)
Removes the sync token value associated to the given any type from the given resource.
|
PagedConnObjectTOResult |
searchConnObjects(@NotNull String key,
@NotNull String anyTypeKey,
ConnObjectTOQuery connObjectTOQuery)
Returns a paged list of connector objects from external resource, for the given type, matching
page/size conditions.
|
void |
setLatestSyncToken(@NotNull String key,
@NotNull String anyTypeKey)
Queries the connector underlying the given resource for the latest sync token value associated to the given any
type and stores the value internally, for later usage.
|
void |
update(@NotNull ResourceTO resourceTO)
Updates the resource matching the given name.
|
@OPTIONS @Path(value="{key}/{anyTypeKey}/{anyKey}") javax.ws.rs.core.Response getConnObjectKeyValue(@NotNull @PathParam(value="key") @NotNull String key, @NotNull @PathParam(value="anyTypeKey") @NotNull String anyTypeKey, @NotNull @PathParam(value="anyKey") @NotNull String anyKey)
key
- name of resource to read connector object fromanyTypeKey
- any object typeanyKey
- user, group or any object key@GET @Path(value="{key}/{anyTypeKey}/{value}") @Produces(value={"application/json","application/yaml","application/xml"}) ConnObjectTO readConnObject(@NotNull @PathParam(value="key") @NotNull String key, @NotNull @PathParam(value="anyTypeKey") @NotNull String anyTypeKey, @NotNull @PathParam(value="value") @NotNull String value)
key
- name of resource to read connector object fromanyTypeKey
- any object typevalue
- if value looks like a UUID then it is interpreted as user, group or any object key, otherwise
as key value on the resource@GET @Path(value="{key}/{anyTypeKey}") @Produces(value={"application/json","application/yaml","application/xml"}) PagedConnObjectTOResult searchConnObjects(@NotNull @PathParam(value="key") @NotNull String key, @NotNull @PathParam(value="anyTypeKey") @NotNull String anyTypeKey, @BeanParam ConnObjectTOQuery connObjectTOQuery)
key
- name of resource to read connector object fromanyTypeKey
- any object typeconnObjectTOQuery
- query conditions@GET @Path(value="{key}") @Produces(value={"application/json","application/yaml","application/xml"}) ResourceTO read(@NotNull @PathParam(value="key") @NotNull String key)
key
- Name of resource to be read@GET @Produces(value={"application/json","application/yaml","application/xml"}) List<ResourceTO> list()
@POST @Consumes(value={"application/json","application/yaml","application/xml"}) @Produces(value={"application/json","application/yaml","application/xml"}) javax.ws.rs.core.Response create(@NotNull @NotNull ResourceTO resourceTO)
resourceTO
- Resource to be created@PUT @Path(value="{key}") @Consumes(value={"application/json","application/yaml","application/xml"}) @Produces(value={"application/json","application/yaml","application/xml"}) void update(@NotNull @NotNull ResourceTO resourceTO)
resourceTO
- resource to be stored@POST @Path(value="{key}/{anyTypeKey}") @Produces(value={"application/json","application/yaml","application/xml"}) void setLatestSyncToken(@NotNull @PathParam(value="key") @NotNull String key, @NotNull @PathParam(value="anyTypeKey") @NotNull String anyTypeKey)
key
- resourceanyTypeKey
- any type@DELETE @Path(value="{key}/{anyTypeKey}") @Produces(value={"application/json","application/yaml","application/xml"}) void removeSyncToken(@NotNull @PathParam(value="key") @NotNull String key, @NotNull @PathParam(value="anyTypeKey") @NotNull String anyTypeKey)
key
- resourceanyTypeKey
- any type@DELETE @Path(value="{key}") @Consumes(value={"application/json","application/yaml","application/xml"}) @Produces(value={"application/json","application/yaml","application/xml"}) void delete(@NotNull @PathParam(value="key") @NotNull String key)
key
- name of resource to be deleted@POST @Path(value="check") @Produces(value={"application/json","application/yaml","application/xml"}) @Consumes(value={"application/json","application/yaml","application/xml"}) void check(@NotNull @NotNull ResourceTO resourceTO)
resourceTO
- resource to be checkedCopyright © 2010–2023 The Apache Software Foundation. All rights reserved.