public interface AnyService<TO extends AnyTO> 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 |
---|---|
javax.ws.rs.core.Response |
associate(@NotNull AssociationPatch patch)
Executes resource-related operations on given entity.
|
javax.ws.rs.core.Response |
deassociate(@NotNull DeassociationPatch patch)
Executes resource-related operations on given entity.
|
javax.ws.rs.core.Response |
delete(@NotNull String key)
Deletes any object matching provided key.
|
void |
delete(@NotNull String key,
@NotNull SchemaType schemaType,
@NotNull String schema)
Deletes the attribute, owned by the given any object, for the given schema type and schema.
|
TO |
read(@NotNull String key)
Reads the any object matching the provided key.
|
Set<AttrTO> |
read(@NotNull String key,
@NotNull SchemaType schemaType)
Reads the list of attributes owned by the given any object for the given schema type.
|
AttrTO |
read(@NotNull String key,
@NotNull SchemaType schemaType,
@NotNull String schema)
Reads the attribute, owned by the given any object, for the given schema type and schema.
|
PagedResult<TO> |
search(AnyQuery anyQuery)
Returns a paged list of any objects matching the given query.
|
javax.ws.rs.core.Response |
update(@NotNull String key,
@NotNull SchemaType schemaType,
@NotNull AttrTO attrTO)
Adds or replaces the attribute, owned by the given any object, for the given schema type and schema.
|
@GET @Path(value="{key}/{schemaType}") @Produces(value={"application/json","application/yaml","application/xml"}) Set<AttrTO> read(@NotNull @PathParam(value="key") @NotNull String key, @NotNull @PathParam(value="schemaType") @NotNull SchemaType schemaType)
key
- any object key or nameschemaType
- schema type@GET @Path(value="{key}/{schemaType}/{schema}") @Produces(value={"application/json","application/yaml","application/xml"}) AttrTO read(@NotNull @PathParam(value="key") @NotNull String key, @NotNull @PathParam(value="schemaType") @NotNull SchemaType schemaType, @NotNull @PathParam(value="schema") @NotNull String schema)
key
- any object key or nameschemaType
- schema typeschema
- schema@GET @Path(value="{key}") @Produces(value={"application/json","application/yaml","application/xml"}) TO read(@NotNull @PathParam(value="key") @NotNull String key)
key
- if value looks like a UUID then it is interpreted as key, otherwise as a (user)name@GET @Produces(value={"application/json","application/yaml","application/xml"}) PagedResult<TO> search(@BeanParam AnyQuery anyQuery)
anyQuery
- query conditions@PUT @Path(value="{key}/{schemaType}/{schema}") @Produces(value={"application/json","application/yaml","application/xml"}) @Consumes(value={"application/json","application/yaml","application/xml"}) javax.ws.rs.core.Response update(@NotNull @PathParam(value="key") @NotNull String key, @NotNull @PathParam(value="schemaType") @NotNull SchemaType schemaType, @NotNull @NotNull AttrTO attrTO)
key
- any object key or nameschemaType
- schema typeattrTO
- attribute@DELETE @Path(value="{key}/{schemaType}/{schema}") @Produces(value={"application/json","application/yaml","application/xml"}) void delete(@NotNull @PathParam(value="key") @NotNull String key, @NotNull @PathParam(value="schemaType") @NotNull SchemaType schemaType, @NotNull @PathParam(value="schema") @NotNull String schema)
key
- any object key or nameschemaType
- schema typeschema
- schema@DELETE @Path(value="{key}") @Produces(value={"application/json","application/yaml","application/xml"}) javax.ws.rs.core.Response delete(@NotNull @PathParam(value="key") @NotNull String key)
key
- any object key or name@POST @Path(value="{key}/deassociate/{action}") @Consumes(value={"application/json","application/yaml","application/xml"}) @Produces(value="multipart/mixed") javax.ws.rs.core.Response deassociate(@NotNull @NotNull DeassociationPatch patch)
patch
- external resources to be used for propagation-related operations@POST @Path(value="{key}/associate/{action}") @Consumes(value={"application/json","application/yaml","application/xml"}) @Produces(value="multipart/mixed") javax.ws.rs.core.Response associate(@NotNull @NotNull AssociationPatch patch)
patch
- external resources to be used for propagation-related operationsCopyright © 2010–2023 The Apache Software Foundation. All rights reserved.