org.apache.syncope.common.services

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.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
BulkActionResult	bulk(BulkAction bulkAction) Executes the provided bulk action.
boolean	check(ConnInstanceTO connInstanceTO)
javax.ws.rs.core.Response	create(ConnInstanceTO connInstanceTO) Creates a new connector instance.
void	delete(Long connInstanceId) Deletes the connector instance matching the provided id.
List<ConnBundleTO>	getBundles(String lang) Returns available connector bundles with property keys in selected language.
List<ConnConfProperty>	getConfigurationProperties(Long connInstanceId) Returns configuration for given connector instance.
List<SchemaTO>	getSchemaNames(Long connInstanceId, ConnInstanceTO connInstanceTO, boolean includeSpecial) Returns schema names for connector bundle matching the given connector instance id.
List<ConnIdObjectClassTO>	getSupportedObjectClasses(Long connInstanceId, ConnInstanceTO connInstanceTO) Returns supported object classes for connector bundle matching the given connector instance id.
List<ConnInstanceTO>	list(String lang) Returns a list of all connector instances with property keys in the matching language.
ConnInstanceTO	read(Long connInstanceId) Returns connector instance with matching id.
ConnInstanceTO	readByResource(String resourceName) Returns connector instance for matching resource.
void	reload() Reload all connector bundles and instances.
void	update(Long connInstanceId, ConnInstanceTO connInstanceTO) Updates the connector instance matching the provided id.

Method Detail

getBundles

@GET
@Path(value="bundles")
@Produces(value={"application/xml","application/json"})
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

getConfigurationProperties

@GET
@Path(value="{connInstanceId}/configuration")
@Produces(value={"application/xml","application/json"})
List<ConnConfProperty> getConfigurationProperties(@NotNull@PathParam(value="connInstanceId")
                                                                  Long connInstanceId)

Returns configuration for given connector instance.

Parameters:

connInstanceId - connector instance id to read configuration from

Returns:

configuration for given connector instance

getSchemaNames

@POST
@Path(value="{connInstanceId}/schemaNames")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
List<SchemaTO> getSchemaNames(@NotNull@PathParam(value="connInstanceId")
                                                        Long connInstanceId,
                                                        @NotNull
                                                        ConnInstanceTO connInstanceTO,
                                                        @QueryParam(value="includeSpecial")@DefaultValue(value="false")
                                                        boolean includeSpecial)

Returns schema names for connector bundle matching the given connector instance id.

Parameters:

connInstanceId - connector instance id to be used for schema lookup

connInstanceTO - connector instance object to provide special configuration properties

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

Returns:

schema names for connector bundle matching the given connector instance id

getSupportedObjectClasses

@POST
@Path(value="{connInstanceId}/supportedObjectClasses")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
List<ConnIdObjectClassTO> getSupportedObjectClasses(@NotNull@PathParam(value="connInstanceId")
                                                                              Long connInstanceId,
                                                                              @NotNull
                                                                              ConnInstanceTO connInstanceTO)

Returns supported object classes for connector bundle matching the given connector instance id.

Parameters:

connInstanceId - connector instance id to be used for schema lookup

connInstanceTO - connector instance object to provide special configuration properties

Returns:

supported object classes for connector bundle matching the given connector instance id

read

@GET
@Path(value="{connInstanceId}")
@Produces(value={"application/xml","application/json"})
ConnInstanceTO read(@NotNull@PathParam(value="connInstanceId")
                                    Long connInstanceId)

Returns connector instance with matching id.

Parameters:

connInstanceId - connector instance id to be read

Returns:

connector instance with matching id

readByResource

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

Returns connector instance for matching resource.

Parameters:

resourceName - resource name to be used for connector lookup

Returns:

connector instance for matching resource

list

@GET
@Produces(value={"application/xml","application/json"})
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/xml","application/json"})
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="{connInstanceId}")
@Consumes(value={"application/xml","application/json"})
void update(@NotNull@PathParam(value="connInstanceId")
                            Long connInstanceId,
                            @NotNull
                            ConnInstanceTO connInstanceTO)

Updates the connector instance matching the provided id.

Parameters:

connInstanceId - connector instance id to be updated

connInstanceTO - connector instance to be stored

delete

@DELETE
@Path(value="{connInstanceId}")
void delete(@NotNull@PathParam(value="connInstanceId")
                      Long connInstanceId)

Deletes the connector instance matching the provided id.

Parameters:

connInstanceId - connector instance id to be deleted

check

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

Parameters:

connInstanceTO - connector instance to be used for connection check

Returns:

true if connection could be established

reload

@POST
@Path(value="reload")
void reload()

Reload all connector bundles and instances.

bulk

@POST
@Path(value="bulk")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
BulkActionResult bulk(@NotNull
                                                BulkAction bulkAction)

Executes the provided bulk action.

Parameters:

bulkAction - list of connector instance ids against which the bulk action will be performed.

Returns:

Bulk action result