Package org.apache.syncope.common.rest.api.service

Interface SAML2SPEntityService

All Superinterfaces:

JAXRSService

All Known Implementing Classes:

SAML2SPEntityServiceImpl

@Path("saml2/sp")
public interface SAML2SPEntityService
extends JAXRSService

REST operations for SAML 2.0 SP entity.

Field Summary

Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService

CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_KEYWORD, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RECURSIVE, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Method Summary

Modifier and Type	Method	Description
void	delete(@NotNull String key)	Delets the SAML 2.0 SP entity matching the given key.
SAML2SPEntityTO	get(@NotNull String key)	Returns the SAML 2.0 SP entity matching the given key.
List<SAML2SPEntityTO>	list()	Returns the SAML 2.0 SP entities.
void	set(@NotNull SAML2SPEntityTO entityTO)	Store the entity to finalize the generation process.

Method Detail

list

@GET
@Produces({"application/json","application/yaml","application/xml"})
List<SAML2SPEntityTO> list()

Returns the SAML 2.0 SP entities.

Returns:

SAML 2.0 SP entities

get

@GET
@Path("{key}")
@Produces({"application/json","application/yaml","application/xml"})
SAML2SPEntityTO get(@NotNull @PathParam("key")
                    @NotNull String key)

Returns the SAML 2.0 SP entity matching the given key.

Parameters:

key - key of requested SAML 2.0 SP entity

Returns:

SAML 2.0 SP entity with matching key

set

@POST
@Path("{key}")
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
void set(@NotNull
         @NotNull SAML2SPEntityTO entityTO)

Store the entity to finalize the generation process.

Parameters:

entityTO - entity to be created

delete

@DELETE
@Path("{key}")
@Produces({"application/json","application/yaml","application/xml"})
void delete(@NotNull @PathParam("key")
            @NotNull String key)

Delets the SAML 2.0 SP entity matching the given key.

Parameters:

key - key of requested SAML 2.0 SP entity