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

Interface ConnectorService

All Superinterfaces:

JAXRSService

@Path(value="connectors")
public interface ConnectorService
extends JAXRSService

REST operations for connector bundles and instances.

Field Summary

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

PARAM_ANYTYPE_KIND, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_RESOURCE, PARAM_SIZE

Method Summary

Modifier and Type	Method and Description
List<ConnIdObjectClassTO>	buildObjectClassInfo(ConnInstanceTO connInstanceTO, boolean includeSpecial) Builds the list of ConnId object classes information for the connector bundle matching the given connector instance key, with the provided configuration.
void	check(ConnInstanceTO connInstanceTO) Checks whether the connection to resource could be established.
javax.ws.rs.core.Response	create(ConnInstanceTO connInstanceTO) Creates a new connector instance.
void	delete(String key) Deletes the connector instance matching the provided key.
List<ConnBundleTO>	getBundles(String lang) Returns available connector bundles with property keys in selected language.
List<ConnInstanceTO>	list(String lang) Returns a list of all connector instances with property keys in the matching language.
ConnInstanceTO	read(String key, String lang) Returns connector instance with matching key.
ConnInstanceTO	readByResource(String resourceName, String lang) Returns connector instance for matching resource.
void	reload() Reload all connector bundles and instances.
void	update(ConnInstanceTO connInstanceTO) Updates the connector instance matching the provided key.

Method Detail

getBundles

@GET
 @Path(value="bundles")
 @Produces(value={"application/json","application/xml"})
List<ConnBundleTO> getBundles(@QueryParam(value="lang")
                                                                                                                    String lang)

Returns available connector bundles with property keys in selected language.

Parameters:

lang - language to select property keys; default language is English

Returns:

available connector bundles with property keys in selected language

buildObjectClassInfo

@POST
 @Path(value="{key}/supportedObjectClasses")
 @Produces(value={"application/json","application/xml"})
 @Consumes(value={"application/json","application/xml"})
List<ConnIdObjectClassTO> buildObjectClassInfo(@NotNull
                                                                                                                                                                                                                    ConnInstanceTO connInstanceTO,
                                                                                                                                                                                                                    @QueryParam(value="includeSpecial") @DefaultValue(value="false")
                                                                                                                                                                                                                    boolean includeSpecial)

Builds the list of ConnId object classes information for the connector bundle matching the given connector instance key, with the provided configuration.

Parameters:

connInstanceTO - connector instance object providing configuration properties

includeSpecial - if set to true, special schema names (like '__PASSWORD__') will be included; default is false

Returns:

supported object classes info for the connector bundle matching the given connector instance key, with the provided configuration

read

@GET
 @Path(value="{key}")
 @Produces(value={"application/json","application/xml"})
ConnInstanceTO read(@NotNull @PathParam(value="key")
                                                                                                        String key,
                                                                                                        @QueryParam(value="lang")
                                                                                                        String lang)

Returns connector instance with matching key.

Parameters:

key - connector instance key to be read

lang - language to select property keys, null for default (English). An ISO 639 alpha-2 or alpha-3 language code, or a language subtag up to 8 characters in length.

Returns:

connector instance with matching key

readByResource

@GET
 @Path(value="byResource/{resourceName}")
 @Produces(value={"application/json","application/xml"})
ConnInstanceTO readByResource(@NotNull @PathParam(value="resourceName")
                                                                                                                                      String resourceName,
                                                                                                                                      @QueryParam(value="lang")
                                                                                                                                      String lang)

Returns connector instance for matching resource.

Parameters:

resourceName - resource name to be used for connector lookup

lang - language to select property keys, null for default (English). An ISO 639 alpha-2 or alpha-3 language code, or a language subtag up to 8 characters in length.

Returns:

connector instance for matching resource

list

@GET
 @Produces(value={"application/json","application/xml"})
List<ConnInstanceTO> list(@QueryParam(value="lang")
                                                                                        String lang)

Returns a list of all connector instances with property keys in the matching language.

Parameters:

lang - language to select property keys, null for default (English). An ISO 639 alpha-2 or alpha-3 language code, or a language subtag up to 8 characters in length.

Returns:

list of all connector instances with property keys in the matching language

create

@POST
 @Consumes(value={"application/json","application/xml"})
 @Produces(value={"application/json","application/xml"})
javax.ws.rs.core.Response create(@NotNull
                                                                                                                                                         ConnInstanceTO connInstanceTO)

Creates a new connector instance.

Parameters:

connInstanceTO - connector instance to be created

Returns:

Response object featuring Location header of created connector instance

update

@PUT
 @Path(value="{key}")
 @Consumes(value={"application/json","application/xml"})
 @Produces(value={"application/json","application/xml"})
void update(@NotNull
                                                                                                                                                         ConnInstanceTO connInstanceTO)

Updates the connector instance matching the provided key.

Parameters:

connInstanceTO - connector instance to be stored

delete

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

Deletes the connector instance matching the provided key.

Parameters:

key - connector instance key to be deleted

check

@POST
 @Path(value="check")
 @Consumes(value={"application/json","application/xml"})
 @Produces(value={"application/json","application/xml"})
void check(@NotNull
                                                                                                                                                         ConnInstanceTO connInstanceTO)

Checks whether the connection to resource could be established.

Parameters:

connInstanceTO - connector instance to be used for connection check

reload

@POST
 @Path(value="reload")
 @Produces(value={"application/json","application/xml"})
void reload()

Reload all connector bundles and instances.