org.apache.syncope.client

Class SyncopeClient

java.lang.Object

org.apache.syncope.client.SyncopeClient

public class SyncopeClient
extends Object

Entry point for client access to all REST services exposed by Syncope core; obtain instances via SyncopeClientFactoryBean.

See Also:

SyncopeClientFactoryBean

Constructor Summary

Constructors

Constructor and Description
SyncopeClient(javax.ws.rs.core.MediaType mediaType, RestClientFactoryBean restClientFactory, String username, String password)

Method Summary

Methods

Modifier and Type	Method and Description
<T> javax.ws.rs.core.EntityTag	getLatestEntityTag(T service) Fetches ETag header value from latest service run (if available).
static org.apache.syncope.common.search.OrderByClauseBuilder	getOrderByClauseBuilder() Returns a new instance of OrderByClauseBuilder, for assisted building of orderby clauses.
static org.apache.syncope.common.search.RoleFiqlSearchConditionBuilder	getRoleSearchConditionBuilder() Returns a new instance of RoleFiqlSearchConditionBuilder, for assisted building of FIQL queries.
<T> T	getService(Class<T> serviceClass) Creates an instance of the given service class, with configured content type and authentication.
static org.apache.syncope.common.search.UserFiqlSearchConditionBuilder	getUserSearchConditionBuilder() Returns a new instance of UserFiqlSearchConditionBuilder, for assisted building of FIQL queries.
<T> T	header(Class<T> serviceClass, String key, Object... values) Creates an instance of the given service class and sets the given header.
<T> T	header(T service, String key, Object... values) Sets the given header on the give service instance.
<T> T	ifMatch(Class<T> serviceClass, javax.ws.rs.core.EntityTag etag) Creates an instance of the given service class, with If-Match header set.
<T> T	ifMatch(T service, javax.ws.rs.core.EntityTag etag) Sets the If-Match header on the given service instance.
<T> T	ifNoneMatch(Class<T> serviceClass, javax.ws.rs.core.EntityTag etag) Creates an instance of the given service class, with If-None-Match header set.
<T> T	ifNoneMatch(T service, javax.ws.rs.core.EntityTag etag) Sets the If-None-Match header on the given service instance.
boolean	isActivitiEnabledFor(org.apache.syncope.common.types.SubjectType subjectType) Checks whether Activiti workflow is enabled for users / roles, by calling WorkflowService's options.
boolean	isPwdResetAllowed() Checks whether password reset is allowed by calling UserSelfService's options.
boolean	isPwdResetRequiringSecurityQuestions() Checks whether password reset requires security question by calling UserSelfService's options.
boolean	isSelfRegAllowed() Checks whether self-registration is allowed by calling UserSelfService's options.
<T> T	prefer(Class<T> serviceClass, org.apache.syncope.common.types.Preference preference) Creates an instance of the given service class, with Prefer header set.
<T> T	prefer(T service, org.apache.syncope.common.types.Preference preference) Sets the Prefer header on the give service instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SyncopeClient

public SyncopeClient(javax.ws.rs.core.MediaType mediaType,
             RestClientFactoryBean restClientFactory,
             String username,
             String password)

Method Detail

getUserSearchConditionBuilder

public static org.apache.syncope.common.search.UserFiqlSearchConditionBuilder getUserSearchConditionBuilder()

Returns a new instance of UserFiqlSearchConditionBuilder, for assisted building of FIQL queries.

Returns:

default instance of UserFiqlSearchConditionBuilder

getRoleSearchConditionBuilder

public static org.apache.syncope.common.search.RoleFiqlSearchConditionBuilder getRoleSearchConditionBuilder()

Returns a new instance of RoleFiqlSearchConditionBuilder, for assisted building of FIQL queries.

Returns:

default instance of RoleFiqlSearchConditionBuilder

getOrderByClauseBuilder

public static org.apache.syncope.common.search.OrderByClauseBuilder getOrderByClauseBuilder()

Returns a new instance of OrderByClauseBuilder, for assisted building of orderby clauses.

Returns:

default instance of OrderByClauseBuilder

getService

public <T> T getService(Class<T> serviceClass)

Creates an instance of the given service class, with configured content type and authentication.

Type Parameters:

T - any service class

Parameters:

serviceClass - service class reference

Returns:

service instance of the given reference class

header

public <T> T header(T service,
           String key,
           Object... values)

Sets the given header on the give service instance.

Type Parameters:

T - any service class

Parameters:

service - service class instance

key - HTTP header key

values - HTTP header values

Returns:

given service instance, with given header set

header

public <T> T header(Class<T> serviceClass,
           String key,
           Object... values)

Creates an instance of the given service class and sets the given header.

Type Parameters:

T - any service class

Parameters:

serviceClass - service class reference

key - HTTP header key

values - HTTP header values

Returns:

service instance of the given reference class, with given header set

prefer

public <T> T prefer(T service,
           org.apache.syncope.common.types.Preference preference)

Sets the Prefer header on the give service instance.

Type Parameters:

T - any service class

Parameters:

service - service class instance

preference - preference to be set via Prefer header

Returns:

given service instance, with Prefer header set

prefer

public <T> T prefer(Class<T> serviceClass,
           org.apache.syncope.common.types.Preference preference)

Creates an instance of the given service class, with Prefer header set.

Type Parameters:

T - any service class

Parameters:

serviceClass - service class reference

preference - preference to be set via Prefer header

Returns:

service instance of the given reference class, with Prefer header set

ifMatch

public <T> T ifMatch(T service,
            javax.ws.rs.core.EntityTag etag)

Sets the If-Match header on the given service instance.

Type Parameters:

T - any service class

Parameters:

service - service class instance

etag - ETag value

Returns:

given service instance, with If-Match set

ifMatch

public <T> T ifMatch(Class<T> serviceClass,
            javax.ws.rs.core.EntityTag etag)

Creates an instance of the given service class, with If-Match header set.

Type Parameters:

T - any service class

Parameters:

serviceClass - service class reference

etag - ETag value

Returns:

given service instance, with If-Match set

ifNoneMatch

public <T> T ifNoneMatch(T service,
                javax.ws.rs.core.EntityTag etag)

Sets the If-None-Match header on the given service instance.

Type Parameters:

T - any service class

Parameters:

service - service class instance

etag - ETag value

Returns:

given service instance, with If-None-Match set

ifNoneMatch

public <T> T ifNoneMatch(Class<T> serviceClass,
                javax.ws.rs.core.EntityTag etag)

Creates an instance of the given service class, with If-None-Match header set.

Type Parameters:

T - any service class

Parameters:

serviceClass - service class reference

etag - ETag value

Returns:

given service instance, with If-None-Match set

isSelfRegAllowed

public boolean isSelfRegAllowed()

Checks whether self-registration is allowed by calling UserSelfService's options.

Returns:

whether self-registration is allowed

See Also:

UserSelfService.getOptions()

isPwdResetAllowed

public boolean isPwdResetAllowed()

Checks whether password reset is allowed by calling UserSelfService's options.

Returns:

whether password reset is allowed

See Also:

UserSelfService.getOptions()

isPwdResetRequiringSecurityQuestions

public boolean isPwdResetRequiringSecurityQuestions()

Checks whether password reset requires security question by calling UserSelfService's options.

Returns:

whether password reset requires security question

See Also:

UserSelfService.getOptions()

isActivitiEnabledFor

public boolean isActivitiEnabledFor(org.apache.syncope.common.types.SubjectType subjectType)

Checks whether Activiti workflow is enabled for users / roles, by calling WorkflowService's options.

Parameters:

subjectType - user / role

Returns:

whether Activiti workflow is enabled for given attributable type

See Also:

WorkflowService.getOptions(org.apache.syncope.common.types.SubjectType)

getLatestEntityTag

public <T> javax.ws.rs.core.EntityTag getLatestEntityTag(T service)

Fetches ETag header value from latest service run (if available).

Type Parameters:

T - any service class

Parameters:

service - service class instance

Returns:

ETag header value from latest service run (if available)