org.apache.syncope.common.services

Interface SchemaService

All Superinterfaces:

JAXRSService

@Path(value="schemas/{kind}/{type}")
public interface SchemaService
extends JAXRSService

REST operations for attribute schemas.

Field Summary

Fields inherited from interface org.apache.syncope.common.services.JAXRSService

DEFAULT_PARAM_PAGE, DEFAULT_PARAM_PAGE_VALUE, DEFAULT_PARAM_SIZE, DEFAULT_PARAM_SIZE_VALUE, PARAM_DETAILS, PARAM_FIQL, PARAM_ORDERBY, PARAM_PAGE, PARAM_SIZE

Method Summary

Methods

Modifier and Type	Method and Description
<T extends AbstractSchemaTO> javax.ws.rs.core.Response	create(AttributableType attrType, SchemaType schemaType, T schemaTO) Creates a new schema.
void	delete(AttributableType attrType, SchemaType schemaType, String schemaName) Deletes the schema matching the given kind, type and name.
<T extends AbstractSchemaTO> List<T>	list(AttributableType attrType, SchemaType schemaType) Returns a list of schemas with matching kind and type.
<T extends AbstractSchemaTO> T	read(AttributableType attrType, SchemaType schemaType, String schemaName) Returns schema matching the given kind, type and name.
<T extends AbstractSchemaTO> void	update(AttributableType attrType, SchemaType schemaType, String schemaName, T schemaTO) Updates the schema matching the given kind, type and name.

Method Detail

read

@GET
@Path(value="{name}")
@Produces(value={"application/xml","application/json"})
<T extends AbstractSchemaTO> T read(@NotNull@PathParam(value="kind")
                                                    AttributableType attrType,
                                                    @NotNull@PathParam(value="type")
                                                    SchemaType schemaType,
                                                    @NotNull@PathParam(value="name")
                                                    String schemaName)

Returns schema matching the given kind, type and name.

Type Parameters:

T - actual SchemaTO

Parameters:

attrType - kind for schemas to be read

schemaType - type for schemas to be read

schemaName - name of schema to be read

Returns:

schema matching the given kind, type and name

list

@GET
@Produces(value={"application/xml","application/json"})
<T extends AbstractSchemaTO> List<T> list(@NotNull@PathParam(value="kind")
                                                     AttributableType attrType,
                                                     @NotNull@PathParam(value="type")
                                                     SchemaType schemaType)

Returns a list of schemas with matching kind and type.

Type Parameters:

T - actual SchemaTO

Parameters:

attrType - kind for schemas to be listed

schemaType - type for schemas to be listed

Returns:

list of schemas with matching kind and type

create

@POST
@Consumes(value={"application/xml","application/json"})
<T extends AbstractSchemaTO> javax.ws.rs.core.Response create(@NotNull@PathParam(value="kind")
                                                                          AttributableType attrType,
                                                                          @NotNull@PathParam(value="type")
                                                                          SchemaType schemaType,
                                                                          @NotNull
                                                                          T schemaTO)

Creates a new schema.

Type Parameters:

T - actual SchemaTO

Parameters:

attrType - kind for schema to be created

schemaType - type for schema to be created

schemaTO - schema to be created

Returns:

Response object featuring Location header of created schema

update

@PUT
@Path(value="{name}")
@Consumes(value={"application/xml","application/json"})
<T extends AbstractSchemaTO> void update(@NotNull@PathParam(value="kind")
                                                         AttributableType attrType,
                                                         @NotNull@PathParam(value="type")
                                                         SchemaType schemaType,
                                                         @NotNull@PathParam(value="name")
                                                         String schemaName,
                                                         @NotNull
                                                         T schemaTO)

Updates the schema matching the given kind, type and name.

Type Parameters:

T - actual SchemaTO

Parameters:

attrType - kind for schemas to be updated

schemaType - type for schemas to be updated

schemaName - name of schema to be updated

schemaTO - updated schema to be stored

delete

@DELETE
@Path(value="{name}")
void delete(@NotNull@PathParam(value="kind")
                      AttributableType attrType,
                      @NotNull@PathParam(value="type")
                      SchemaType schemaType,
                      @NotNull@PathParam(value="name")
                      String schemaName)

Deletes the schema matching the given kind, type and name.

Parameters:

attrType - kind for schema to be deleted

schemaType - type for schema to be deleted

schemaName - name of schema to be deleted