Skip navigation links
A B C D E F G H J K L M N O P R S T U V W 

A

AbstractQuery - Class in org.apache.syncope.common.rest.api.beans
 
AbstractQuery() - Constructor for class org.apache.syncope.common.rest.api.beans.AbstractQuery
 
AbstractQuery.Builder<Q extends AbstractQuery,B extends AbstractQuery.Builder<Q,B>> - Class in org.apache.syncope.common.rest.api.beans
 
AccessTokenQuery - Class in org.apache.syncope.common.rest.api.beans
 
AccessTokenQuery() - Constructor for class org.apache.syncope.common.rest.api.beans.AccessTokenQuery
 
AccessTokenQuery.Builder - Class in org.apache.syncope.common.rest.api.beans
 
AccessTokenService - Interface in org.apache.syncope.common.rest.api.service
REST operations for access tokens.
actionJob(String, JobAction) - Method in interface org.apache.syncope.common.rest.api.service.ExecutableService
Executes an action on an existing executable's job.
actionJob(JobAction) - Method in interface org.apache.syncope.common.rest.api.service.NotificationService
Executes an action on the notification job.
AnyObjectService - Interface in org.apache.syncope.common.rest.api.service
REST operations for anyObjects.
AnyQuery - Class in org.apache.syncope.common.rest.api.beans
 
AnyQuery() - Constructor for class org.apache.syncope.common.rest.api.beans.AnyQuery
 
AnyQuery.Builder - Class in org.apache.syncope.common.rest.api.beans
 
AnyService<TO extends AnyTO> - Interface in org.apache.syncope.common.rest.api.service
 
anyTypeClass(String) - Method in class org.apache.syncope.common.rest.api.beans.SchemaQuery.Builder
 
anyTypeClasses(Collection<String>) - Method in class org.apache.syncope.common.rest.api.beans.SchemaQuery.Builder
 
anyTypeClasses(String...) - Method in class org.apache.syncope.common.rest.api.beans.SchemaQuery.Builder
 
AnyTypeClassService - Interface in org.apache.syncope.common.rest.api.service
REST operations for any type classes.
anyTypeKind(AnyTypeKind) - Method in class org.apache.syncope.common.rest.api.beans.TaskQuery.Builder
 
AnyTypeService - Interface in org.apache.syncope.common.rest.api.service
REST operations for any types.
associate(AssociationPatch) - Method in interface org.apache.syncope.common.rest.api.service.AnyService
Executes resource-related operations on given entity.

B

build() - Method in class org.apache.syncope.common.rest.api.beans.AbstractQuery.Builder
 
build() - Method in class org.apache.syncope.common.rest.api.beans.BulkExecDeleteQuery.Builder
 
build() - Method in class org.apache.syncope.common.rest.api.beans.ConnObjectTOListQuery.Builder
 
build() - Method in class org.apache.syncope.common.rest.api.beans.ExecuteQuery.Builder
 
build() - Method in class org.apache.syncope.common.rest.api.beans.SchemaQuery.Builder
 
Builder() - Constructor for class org.apache.syncope.common.rest.api.beans.AbstractQuery.Builder
 
Builder() - Constructor for class org.apache.syncope.common.rest.api.beans.AccessTokenQuery.Builder
 
Builder() - Constructor for class org.apache.syncope.common.rest.api.beans.AnyQuery.Builder
 
Builder() - Constructor for class org.apache.syncope.common.rest.api.beans.BulkExecDeleteQuery.Builder
 
Builder() - Constructor for class org.apache.syncope.common.rest.api.beans.ConnObjectTOListQuery.Builder
 
Builder() - Constructor for class org.apache.syncope.common.rest.api.beans.ExecQuery.Builder
 
Builder() - Constructor for class org.apache.syncope.common.rest.api.beans.ExecuteQuery.Builder
 
Builder() - Constructor for class org.apache.syncope.common.rest.api.beans.SchemaQuery.Builder
 
Builder(TaskType) - Constructor for class org.apache.syncope.common.rest.api.beans.TaskQuery.Builder
 
Builder() - Constructor for class org.apache.syncope.common.rest.api.beans.WorkflowFormQuery.Builder
 
buildObjectClassInfo(ConnInstanceTO, boolean) - Method in interface org.apache.syncope.common.rest.api.service.ConnectorService
Builds the list of ConnId object classes information for the connector bundle matching the given connector instance key, with the provided configuration.
bulk(BulkAction) - Method in interface org.apache.syncope.common.rest.api.service.AnyService
Executes the provided bulk action.
bulk(BulkAction) - Method in interface org.apache.syncope.common.rest.api.service.TaskService
Executes the provided bulk action.
bulkDeassociation(ResourceDeassociationPatch) - Method in interface org.apache.syncope.common.rest.api.service.ResourceService
De-associate any objects from the given resource.
BulkExecDeleteQuery - Class in org.apache.syncope.common.rest.api.beans
 
BulkExecDeleteQuery() - Constructor for class org.apache.syncope.common.rest.api.beans.BulkExecDeleteQuery
 
BulkExecDeleteQuery.Builder - Class in org.apache.syncope.common.rest.api.beans
 
bulkMembersAction(String, BulkMembersActionType) - Method in interface org.apache.syncope.common.rest.api.service.GroupService
(De)provision all members of the given group from / onto all the resources associated to it.

C

check(ConnInstanceTO) - Method in interface org.apache.syncope.common.rest.api.service.ConnectorService
Checks whether the connection to resource could be established.
check(ResourceTO) - Method in interface org.apache.syncope.common.rest.api.service.ResourceService
Checks whether the connection to resource could be established.
claimForm(String) - Method in interface org.apache.syncope.common.rest.api.service.UserWorkflowService
Claims the form for the given task id.
ConfigurationService - Interface in org.apache.syncope.common.rest.api.service
REST operations for configuration.
confirmPasswordReset(String, String) - Method in interface org.apache.syncope.common.rest.api.service.UserSelfService
Reset the password value for the user matching the provided token, if available and still valid.
ConnectorHistoryService - Interface in org.apache.syncope.common.rest.api.service
REST operations for connector configuration versioning.
ConnectorService - Interface in org.apache.syncope.common.rest.api.service
REST operations for connector bundles and instances.
ConnObjectTOListQuery - Class in org.apache.syncope.common.rest.api.beans
 
ConnObjectTOListQuery() - Constructor for class org.apache.syncope.common.rest.api.beans.ConnObjectTOListQuery
 
ConnObjectTOListQuery.Builder - Class in org.apache.syncope.common.rest.api.beans
 
create(AnyObjectTO) - Method in interface org.apache.syncope.common.rest.api.service.AnyObjectService
Creates a new any object.
create(AnyTypeClassTO) - Method in interface org.apache.syncope.common.rest.api.service.AnyTypeClassService
Creates a new anyTypeClass.
create(AnyTypeTO) - Method in interface org.apache.syncope.common.rest.api.service.AnyTypeService
Creates a new anyType.
create(ConnInstanceTO) - Method in interface org.apache.syncope.common.rest.api.service.ConnectorService
Creates a new connector instance.
create(DomainTO) - Method in interface org.apache.syncope.common.rest.api.service.DomainService
Creates a new domain.
create(DynRealmTO) - Method in interface org.apache.syncope.common.rest.api.service.DynRealmService
Creates a new dynamic realm.
create(GroupTO) - Method in interface org.apache.syncope.common.rest.api.service.GroupService
Creates a new group.
create(MailTemplateTO) - Method in interface org.apache.syncope.common.rest.api.service.MailTemplateService
Creates a new mail template.
create(NotificationTO) - Method in interface org.apache.syncope.common.rest.api.service.NotificationService
Creates a new notification.
create(PolicyType, PolicyTO) - Method in interface org.apache.syncope.common.rest.api.service.PolicyService
Create a new policy.
create(String, RealmTO) - Method in interface org.apache.syncope.common.rest.api.service.RealmService
Creates a new realm under the given path.
create(RelationshipTypeTO) - Method in interface org.apache.syncope.common.rest.api.service.RelationshipTypeService
Creates a new relationshipType.
create(ReportTO) - Method in interface org.apache.syncope.common.rest.api.service.ReportService
Creates a new report.
create(ReportTemplateTO) - Method in interface org.apache.syncope.common.rest.api.service.ReportTemplateService
Creates a new report template.
create(ResourceTO) - Method in interface org.apache.syncope.common.rest.api.service.ResourceService
Creates a new resource.
create(RoleTO) - Method in interface org.apache.syncope.common.rest.api.service.RoleService
Creates a new role.
create(SchemaType, SchemaTO) - Method in interface org.apache.syncope.common.rest.api.service.SchemaService
Creates a new schema.
create(SecurityQuestionTO) - Method in interface org.apache.syncope.common.rest.api.service.SecurityQuestionService
Creates a new security question.
create(TaskType, SchedTaskTO) - Method in interface org.apache.syncope.common.rest.api.service.TaskService
Creates a new task.
create(UserTO, boolean) - Method in interface org.apache.syncope.common.rest.api.service.UserSelfService
Self-registration for new user.
create(UserTO, boolean) - Method in interface org.apache.syncope.common.rest.api.service.UserService
Creates a new user.

D

DateParamConverterProvider - Class in org.apache.syncope.common.rest.api
 
DateParamConverterProvider() - Constructor for class org.apache.syncope.common.rest.api.DateParamConverterProvider
 
deassociate(DeassociationPatch) - Method in interface org.apache.syncope.common.rest.api.service.AnyService
Executes resource-related operations on given entity.
delete(String) - Method in interface org.apache.syncope.common.rest.api.service.AccessTokenService
Invalidates the access token matching the provided key.
delete(String, SchemaType, String) - Method in interface org.apache.syncope.common.rest.api.service.AnyService
Deletes the attribute, owned by the given any object, for the given schema type and schema.
delete(String) - Method in interface org.apache.syncope.common.rest.api.service.AnyService
Deletes any object matching provided key.
delete(String) - Method in interface org.apache.syncope.common.rest.api.service.AnyTypeClassService
Deletes the anyTypeClass matching the provided key.
delete(String) - Method in interface org.apache.syncope.common.rest.api.service.AnyTypeService
Deletes the anyType matching the provided key.
delete(String) - Method in interface org.apache.syncope.common.rest.api.service.ConfigurationService
Deletes the configuration parameter with matching schema.
delete(String) - Method in interface org.apache.syncope.common.rest.api.service.ConnectorHistoryService
Deletes the connector configuration history instance matching the provided key.
delete(String) - Method in interface org.apache.syncope.common.rest.api.service.ConnectorService
Deletes the connector instance matching the provided key.
delete(String) - Method in interface org.apache.syncope.common.rest.api.service.DomainService
Deletes the domain matching the provided key.
delete(String) - Method in interface org.apache.syncope.common.rest.api.service.DynRealmService
Deletes the dynamic realm matching the provided key.
delete(LoggerType, String) - Method in interface org.apache.syncope.common.rest.api.service.LoggerService
Deletes the logger with matching name.
delete(String) - Method in interface org.apache.syncope.common.rest.api.service.MailTemplateService
Deletes the mail template matching the given key.
delete(String) - Method in interface org.apache.syncope.common.rest.api.service.NotificationService
Deletes the notification matching the given key.
delete(PolicyType, String) - Method in interface org.apache.syncope.common.rest.api.service.PolicyService
Delete policy matching the given key.
delete(String) - Method in interface org.apache.syncope.common.rest.api.service.RealmService
Deletes the realm under the given path.
delete(String) - Method in interface org.apache.syncope.common.rest.api.service.RelationshipTypeService
Deletes the relationshipType matching the provided key.
delete(String) - Method in interface org.apache.syncope.common.rest.api.service.ReportService
Deletes report with matching key.
delete(String) - Method in interface org.apache.syncope.common.rest.api.service.ReportTemplateService
Deletes the report template matching the given key.
delete(String) - Method in interface org.apache.syncope.common.rest.api.service.ResourceHistoryService
Deletes the resource configuration history matching the provided key.
delete(String) - Method in interface org.apache.syncope.common.rest.api.service.ResourceService
Deletes the resource matching the given name.
delete(String) - Method in interface org.apache.syncope.common.rest.api.service.RoleService
Deletes the role matching the provided key.
delete(SchemaType, String) - Method in interface org.apache.syncope.common.rest.api.service.SchemaService
Deletes the schema matching the given type and key.
delete(String) - Method in interface org.apache.syncope.common.rest.api.service.SecurityQuestionService
Deletes the security question matching the provided key.
delete(TaskType, String) - Method in interface org.apache.syncope.common.rest.api.service.TaskService
Deletes the task matching the provided key.
delete() - Method in interface org.apache.syncope.common.rest.api.service.UserSelfService
Self-deletes user.
delete(String, String) - Method in interface org.apache.syncope.common.rest.api.service.WorkflowService
Removes the workflow definition for matching any object type, under the provided key.
deleteExecution(String) - Method in interface org.apache.syncope.common.rest.api.service.ExecutableService
Deletes the executable execution matching the provided key.
deleteExecutions(BulkExecDeleteQuery) - Method in interface org.apache.syncope.common.rest.api.service.ExecutableService
Deletes the executions belonging matching the given query.
details(boolean) - Method in class org.apache.syncope.common.rest.api.beans.AnyQuery.Builder
 
details(boolean) - Method in class org.apache.syncope.common.rest.api.beans.TaskQuery.Builder
 
DOMAIN - Static variable in class org.apache.syncope.common.rest.api.RESTHeaders
 
DomainService - Interface in org.apache.syncope.common.rest.api.service
REST operations for domains.
dryRun(boolean) - Method in class org.apache.syncope.common.rest.api.beans.ExecuteQuery.Builder
 
DynRealmService - Interface in org.apache.syncope.common.rest.api.service
REST operations for dynamic realms.

E

endedAfter(Date) - Method in class org.apache.syncope.common.rest.api.beans.BulkExecDeleteQuery.Builder
 
endedBefore(Date) - Method in class org.apache.syncope.common.rest.api.beans.BulkExecDeleteQuery.Builder
 
entityKey(String) - Method in class org.apache.syncope.common.rest.api.beans.TaskQuery.Builder
 
equals(Object) - Method in class org.apache.syncope.common.rest.api.beans.ConnObjectTOListQuery
 
ERROR_CODE - Static variable in class org.apache.syncope.common.rest.api.RESTHeaders
Declares the type of exception being raised.
ERROR_INFO - Static variable in class org.apache.syncope.common.rest.api.RESTHeaders
Declares additional information for the exception being raised.
events() - Method in interface org.apache.syncope.common.rest.api.service.LoggerService
Returns the list of all managed events in audit.
ExecQuery - Class in org.apache.syncope.common.rest.api.beans
 
ExecQuery() - Constructor for class org.apache.syncope.common.rest.api.beans.ExecQuery
 
ExecQuery.Builder - Class in org.apache.syncope.common.rest.api.beans
 
ExecutableService - Interface in org.apache.syncope.common.rest.api.service
 
execute(ExecuteQuery) - Method in interface org.apache.syncope.common.rest.api.service.ExecutableService
Executes the executable matching the given query.
ExecuteQuery - Class in org.apache.syncope.common.rest.api.beans
 
ExecuteQuery() - Constructor for class org.apache.syncope.common.rest.api.beans.ExecuteQuery
 
ExecuteQuery.Builder - Class in org.apache.syncope.common.rest.api.beans
 
executeTask(String, UserTO) - Method in interface org.apache.syncope.common.rest.api.service.UserWorkflowService
Executes workflow task for matching id.
export() - Method in interface org.apache.syncope.common.rest.api.service.ConfigurationService
Exports internal storage content as downloadable XML file.
exportDiagram(String, String) - Method in interface org.apache.syncope.common.rest.api.service.WorkflowService
Exports the workflow diagram representation (if available), for matching any object type and key.
exportExecutionResult(String, ReportExecExportFormat) - Method in interface org.apache.syncope.common.rest.api.service.ReportService
Exports the report execution with matching key in the requested format.

F

fiql(String) - Method in class org.apache.syncope.common.rest.api.beans.AnyQuery.Builder
 
fromString(String) - Static method in enum org.apache.syncope.common.rest.api.Preference
 

G

get(String) - Method in interface org.apache.syncope.common.rest.api.service.ConfigurationService
Returns configuration parameter with matching schema.
get(String, String) - Method in interface org.apache.syncope.common.rest.api.service.WorkflowService
Exports the workflow definition for matching any object type and key.
getAnyTypeClasses() - Method in class org.apache.syncope.common.rest.api.beans.SchemaQuery
 
getAnyTypeKind() - Method in class org.apache.syncope.common.rest.api.beans.TaskQuery
 
getAvailableTasks(String) - Method in interface org.apache.syncope.common.rest.api.service.UserWorkflowService
Returns a list of available tasks for the given user key.
getBundles(String) - Method in interface org.apache.syncope.common.rest.api.service.ConnectorService
Returns available connector bundles with property keys in selected language.
getConsoleLayoutInfo(String) - Method in interface org.apache.syncope.common.rest.api.service.RoleService
Gets the console layout information as JSON string for the role with the given key, if available.
getConverter(Class<T>, Type, Annotation[]) - Method in class org.apache.syncope.common.rest.api.DateParamConverterProvider
 
getDetails() - Method in class org.apache.syncope.common.rest.api.beans.AnyQuery
 
getDetails() - Method in class org.apache.syncope.common.rest.api.beans.TaskQuery
 
getDryRun() - Method in class org.apache.syncope.common.rest.api.beans.ExecuteQuery
 
getEndedAfter() - Method in class org.apache.syncope.common.rest.api.beans.BulkExecDeleteQuery
 
getEndedBefore() - Method in class org.apache.syncope.common.rest.api.beans.BulkExecDeleteQuery
 
getEntityKey() - Method in class org.apache.syncope.common.rest.api.beans.TaskQuery
 
getFiql() - Method in class org.apache.syncope.common.rest.api.beans.AnyQuery
 
getFormat(String, MailTemplateFormat) - Method in interface org.apache.syncope.common.rest.api.service.MailTemplateService
Gets the template for the given key and format, if available.
getFormat(String, ReportTemplateFormat) - Method in interface org.apache.syncope.common.rest.api.service.ReportTemplateService
Gets the template for the given key and format, if available.
getFormForUser(String) - Method in interface org.apache.syncope.common.rest.api.service.UserWorkflowService
Returns a list of available forms for the given user key.
getForms(WorkflowFormQuery) - Method in interface org.apache.syncope.common.rest.api.service.UserWorkflowService
Returns a list of all available workflow forms.
getInstance() - Method in class org.apache.syncope.common.rest.api.beans.AbstractQuery.Builder
 
getJob(String) - Method in interface org.apache.syncope.common.rest.api.service.ExecutableService
Returns job (running or scheduled) for the executable matching the given key.
getJob() - Method in interface org.apache.syncope.common.rest.api.service.NotificationService
Returns details about notification job.
getKey() - Method in class org.apache.syncope.common.rest.api.beans.BulkExecDeleteQuery
 
getKey() - Method in class org.apache.syncope.common.rest.api.beans.ExecQuery
 
getKey() - Method in class org.apache.syncope.common.rest.api.beans.ExecuteQuery
 
getKeyword() - Method in class org.apache.syncope.common.rest.api.beans.SchemaQuery
 
getLastLogStatements(String) - Method in interface org.apache.syncope.common.rest.api.service.LoggerService
Return the last log statements available in the provided memory appender.
getNotification() - Method in class org.apache.syncope.common.rest.api.beans.TaskQuery
 
getOrderBy() - Method in class org.apache.syncope.common.rest.api.beans.AbstractQuery
 
getOrderBy() - Method in class org.apache.syncope.common.rest.api.beans.ConnObjectTOListQuery
 
getPage() - Method in class org.apache.syncope.common.rest.api.beans.AbstractQuery
 
getPagedResultsCookie() - Method in class org.apache.syncope.common.rest.api.beans.ConnObjectTOListQuery
 
getRealm() - Method in class org.apache.syncope.common.rest.api.beans.AnyQuery
 
getResource() - Method in class org.apache.syncope.common.rest.api.beans.TaskQuery
 
getSize() - Method in class org.apache.syncope.common.rest.api.beans.AbstractQuery
 
getSize() - Method in class org.apache.syncope.common.rest.api.beans.ConnObjectTOListQuery
 
getStartAt() - Method in class org.apache.syncope.common.rest.api.beans.ExecuteQuery
 
getStartedAfter() - Method in class org.apache.syncope.common.rest.api.beans.BulkExecDeleteQuery
 
getStartedBefore() - Method in class org.apache.syncope.common.rest.api.beans.BulkExecDeleteQuery
 
getType() - Method in class org.apache.syncope.common.rest.api.beans.SchemaQuery
 
getType() - Method in class org.apache.syncope.common.rest.api.beans.TaskQuery
 
GroupService - Interface in org.apache.syncope.common.rest.api.service
REST operations for groups.

H

hashCode() - Method in class org.apache.syncope.common.rest.api.beans.ConnObjectTOListQuery
 

J

JAXRSService - Interface in org.apache.syncope.common.rest.api.service
 

K

key(String) - Method in class org.apache.syncope.common.rest.api.beans.BulkExecDeleteQuery.Builder
 
key(String) - Method in class org.apache.syncope.common.rest.api.beans.ExecQuery.Builder
 
key(String) - Method in class org.apache.syncope.common.rest.api.beans.ExecuteQuery.Builder
 
keyword(String) - Method in class org.apache.syncope.common.rest.api.beans.SchemaQuery.Builder
 

L

list(AccessTokenQuery) - Method in interface org.apache.syncope.common.rest.api.service.AccessTokenService
Returns a paged list of existing access tokens matching the given query.
list() - Method in interface org.apache.syncope.common.rest.api.service.AnyTypeClassService
Returns a list of all anyTypeClasss.
list() - Method in interface org.apache.syncope.common.rest.api.service.AnyTypeService
Returns a list of all anyTypes.
list() - Method in interface org.apache.syncope.common.rest.api.service.ConfigurationService
Returns all configuration parameters.
list(String) - Method in interface org.apache.syncope.common.rest.api.service.ConnectorHistoryService
Returns a list of all connector configuration history instances for the given connector instance key.
list(String) - Method in interface org.apache.syncope.common.rest.api.service.ConnectorService
Returns a list of all connector instances with property keys in the matching language.
list() - Method in interface org.apache.syncope.common.rest.api.service.DomainService
Returns a list of all domains.
list() - Method in interface org.apache.syncope.common.rest.api.service.DynRealmService
Returns a list of all dynamic realms.
list(LoggerType) - Method in interface org.apache.syncope.common.rest.api.service.LoggerService
Returns a list of loggers with matching type.
list() - Method in interface org.apache.syncope.common.rest.api.service.MailTemplateService
Returns a list of all mail templates.
list() - Method in interface org.apache.syncope.common.rest.api.service.NotificationService
Returns a list of all notifications.
list(PolicyType) - Method in interface org.apache.syncope.common.rest.api.service.PolicyService
Returns a list of policies of the matching type.
list() - Method in interface org.apache.syncope.common.rest.api.service.RealmService
Returns a list of all realms.
list(String) - Method in interface org.apache.syncope.common.rest.api.service.RealmService
Returns realms rooted at the given path.
list() - Method in interface org.apache.syncope.common.rest.api.service.RelationshipTypeService
Returns a list of all relationshipTypes.
list() - Method in interface org.apache.syncope.common.rest.api.service.ReportService
Returns a list of all existing reports.
list() - Method in interface org.apache.syncope.common.rest.api.service.ReportTemplateService
Returns a list of all report templates.
list(String) - Method in interface org.apache.syncope.common.rest.api.service.ResourceHistoryService
Returns a list of all resource configuration history for the given resource key.
list() - Method in interface org.apache.syncope.common.rest.api.service.ResourceService
Returns a list of all resources.
list() - Method in interface org.apache.syncope.common.rest.api.service.RoleService
Returns a list of all roles.
list() - Method in interface org.apache.syncope.common.rest.api.service.SecurityQuestionService
Returns a list of all security questions.
list(String) - Method in interface org.apache.syncope.common.rest.api.service.WorkflowService
Lists the available workflow definitions, for the given any object type.
listConnObjects(String, String, ConnObjectTOListQuery) - Method in interface org.apache.syncope.common.rest.api.service.ResourceService
Returns a paged list of connector objects from external resource, for the given type, matching page/size conditions.
listExecutions(ExecQuery) - Method in interface org.apache.syncope.common.rest.api.service.ExecutableService
Returns a paged list of executions matching the given query.
listJobs() - Method in interface org.apache.syncope.common.rest.api.service.ExecutableService
List jobs (running and / or scheduled).
listRecentExecutions(int) - Method in interface org.apache.syncope.common.rest.api.service.ExecutableService
Returns the list of recently completed executions, ordered by end date descendent.
LoggerService - Interface in org.apache.syncope.common.rest.api.service
REST operations for logging and auditing.
LoggerWrapper - Class in org.apache.syncope.common.rest.api
 
login() - Method in interface org.apache.syncope.common.rest.api.service.AccessTokenService
Returns an empty response bearing the X-Syncope-Token header value, in case of successful authentication.
logout() - Method in interface org.apache.syncope.common.rest.api.service.AccessTokenService
Invalidates the access token of the requesting user.

M

MailTemplateService - Interface in org.apache.syncope.common.rest.api.service
REST operations for mail templates.
MEDIATYPE_IMAGE_PNG - Static variable in class org.apache.syncope.common.rest.api.RESTHeaders
Mediatype for PNG images, not defined in javax.ws.rs.core.MediaType.
memoryAppenders() - Method in interface org.apache.syncope.common.rest.api.service.LoggerService
Returns the list of memory appenders available in the current logging configuration.
mustChangePassword(String) - Method in interface org.apache.syncope.common.rest.api.service.UserSelfService
Changes own password when change was forced by an administrator.

N

newInstance() - Method in class org.apache.syncope.common.rest.api.beans.AbstractQuery.Builder
 
newInstance() - Method in class org.apache.syncope.common.rest.api.beans.AccessTokenQuery.Builder
 
newInstance() - Method in class org.apache.syncope.common.rest.api.beans.AnyQuery.Builder
 
newInstance() - Method in class org.apache.syncope.common.rest.api.beans.ExecQuery.Builder
 
newInstance() - Method in class org.apache.syncope.common.rest.api.beans.TaskQuery.Builder
 
newInstance() - Method in class org.apache.syncope.common.rest.api.beans.WorkflowFormQuery.Builder
 
notification(String) - Method in class org.apache.syncope.common.rest.api.beans.TaskQuery.Builder
 
NotificationService - Interface in org.apache.syncope.common.rest.api.service
REST operations for notifications.
NULL_PRIORITY_ASYNC - Static variable in class org.apache.syncope.common.rest.api.RESTHeaders
Asks for asynchronous propagation towards external resources with null priority.
numbers() - Method in interface org.apache.syncope.common.rest.api.service.SyncopeService
Provides some numbers about the managed entities (users, groups, any objects...).

O

orderBy(String) - Method in class org.apache.syncope.common.rest.api.beans.AbstractQuery.Builder
 
orderBy(String) - Method in class org.apache.syncope.common.rest.api.beans.ConnObjectTOListQuery.Builder
 
org.apache.syncope.common.rest.api - package org.apache.syncope.common.rest.api
 
org.apache.syncope.common.rest.api.beans - package org.apache.syncope.common.rest.api.beans
 
org.apache.syncope.common.rest.api.service - package org.apache.syncope.common.rest.api.service
 
own() - Method in interface org.apache.syncope.common.rest.api.service.GroupService
This method allows a user to read his own groups.
OWNED_ENTITLEMENTS - Static variable in class org.apache.syncope.common.rest.api.RESTHeaders
 

P

page(Integer) - Method in class org.apache.syncope.common.rest.api.beans.AbstractQuery.Builder
 
pagedResultsCookie(String) - Method in class org.apache.syncope.common.rest.api.beans.ConnObjectTOListQuery.Builder
 
PARAM_ANYTYPE_KIND - Static variable in interface org.apache.syncope.common.rest.api.service.JAXRSService
 
PARAM_CONNID_PAGED_RESULTS_COOKIE - Static variable in interface org.apache.syncope.common.rest.api.service.JAXRSService
 
PARAM_DETAILS - Static variable in interface org.apache.syncope.common.rest.api.service.JAXRSService
 
PARAM_ENTITY_KEY - Static variable in interface org.apache.syncope.common.rest.api.service.JAXRSService
 
PARAM_FIQL - Static variable in interface org.apache.syncope.common.rest.api.service.JAXRSService
 
PARAM_MAX - Static variable in interface org.apache.syncope.common.rest.api.service.JAXRSService
 
PARAM_NOTIFICATION - Static variable in interface org.apache.syncope.common.rest.api.service.JAXRSService
 
PARAM_ORDERBY - Static variable in interface org.apache.syncope.common.rest.api.service.JAXRSService
 
PARAM_PAGE - Static variable in interface org.apache.syncope.common.rest.api.service.JAXRSService
 
PARAM_RESOURCE - Static variable in interface org.apache.syncope.common.rest.api.service.JAXRSService
 
PARAM_SIZE - Static variable in interface org.apache.syncope.common.rest.api.service.JAXRSService
 
platform() - Method in interface org.apache.syncope.common.rest.api.service.SyncopeService
Provides information summary about platform configuration (workflow adapters, provisioning managers, validators, actions, correlation rules, reportlets, ...).
PolicyService - Interface in org.apache.syncope.common.rest.api.service
REST operations for policies.
PREFER - Static variable in class org.apache.syncope.common.rest.api.RESTHeaders
Allows the client to specify a preference for the result to be returned from the server.
Preference - Enum in org.apache.syncope.common.rest.api
Preferences available to be specified during requests.
PREFERENCE_APPLIED - Static variable in class org.apache.syncope.common.rest.api.RESTHeaders
Allows the server to inform the client about the fact that a specified preference was applied.
pull(AnyTypeKind, String, String, PullTaskTO) - Method in interface org.apache.syncope.common.rest.api.service.ReconciliationService
Pulls the given user, group or any object from the External Resource into Syncope.
push(AnyTypeKind, String, String, PushTaskTO) - Method in interface org.apache.syncope.common.rest.api.service.ReconciliationService
Pushes the given user, group or any object in Syncope onto the External Resource.

R

read(String) - Method in interface org.apache.syncope.common.rest.api.service.AnyObjectService
 
read(String, SchemaType) - Method in interface org.apache.syncope.common.rest.api.service.AnyService
Reads the list of attributes owned by the given any object for the given schema type.
read(String, SchemaType, String) - Method in interface org.apache.syncope.common.rest.api.service.AnyService
Reads the attribute, owned by the given any object, for the given schema type and schema.
read(String) - Method in interface org.apache.syncope.common.rest.api.service.AnyService
Reads the any object matching the provided key.
read(String) - Method in interface org.apache.syncope.common.rest.api.service.AnyTypeClassService
Returns anyTypeClass with matching key.
read(String) - Method in interface org.apache.syncope.common.rest.api.service.AnyTypeService
Returns anyType with matching key.
read(String, String) - Method in interface org.apache.syncope.common.rest.api.service.ConnectorService
Returns connector instance with matching key.
read(String) - Method in interface org.apache.syncope.common.rest.api.service.DomainService
Returns domain with matching key.
read(String) - Method in interface org.apache.syncope.common.rest.api.service.DynRealmService
Returns dynamic realm with matching key.
read(String) - Method in interface org.apache.syncope.common.rest.api.service.GroupService
 
read(LoggerType, String) - Method in interface org.apache.syncope.common.rest.api.service.LoggerService
Returns logger with matching type and name.
read(String) - Method in interface org.apache.syncope.common.rest.api.service.MailTemplateService
Returns mail template with matching key.
read(String) - Method in interface org.apache.syncope.common.rest.api.service.NotificationService
Returns notification with matching key.
read(PolicyType, String) - Method in interface org.apache.syncope.common.rest.api.service.PolicyService
Returns the policy matching the given key.
read(String) - Method in interface org.apache.syncope.common.rest.api.service.RelationshipTypeService
Returns relationshipType with matching key.
read(String) - Method in interface org.apache.syncope.common.rest.api.service.ReportService
Returns report with matching key.
read(String) - Method in interface org.apache.syncope.common.rest.api.service.ReportTemplateService
Returns report template with matching key.
read(String) - Method in interface org.apache.syncope.common.rest.api.service.ResourceService
Returns the resource with matching name.
read(String) - Method in interface org.apache.syncope.common.rest.api.service.RoleService
Returns role with matching key.
read(SchemaType, String) - Method in interface org.apache.syncope.common.rest.api.service.SchemaService
Returns schema matching the given type and key.
read(String) - Method in interface org.apache.syncope.common.rest.api.service.SecurityQuestionService
Returns security question with matching key.
read(TaskType, String, boolean) - Method in interface org.apache.syncope.common.rest.api.service.TaskService
Returns the task matching the given key.
read() - Method in interface org.apache.syncope.common.rest.api.service.UserSelfService
Returns the user making the service call.
read(String) - Method in interface org.apache.syncope.common.rest.api.service.UserService
 
readByResource(String, String) - Method in interface org.apache.syncope.common.rest.api.service.ConnectorService
Returns connector instance for matching resource.
readByUser(String) - Method in interface org.apache.syncope.common.rest.api.service.SecurityQuestionService
Ask for security question configured for the user matching the given username, if any.
readConnObject(String, String, String) - Method in interface org.apache.syncope.common.rest.api.service.ResourceService
Returns connector object from the external resource, for the given type and key.
readUserTypeExtension(String) - Method in interface org.apache.syncope.common.rest.api.service.SyncopeService
Extracts User type extension information, for the provided group.
realm(String) - Method in class org.apache.syncope.common.rest.api.beans.AnyQuery.Builder
 
RealmService - Interface in org.apache.syncope.common.rest.api.service
REST operations for realms.
ReconciliationService - Interface in org.apache.syncope.common.rest.api.service
REST operations for tasks.
refresh() - Method in interface org.apache.syncope.common.rest.api.service.AccessTokenService
Returns an empty response bearing the X-Syncope-Token header value, with extended lifetime.
RelationshipTypeService - Interface in org.apache.syncope.common.rest.api.service
REST operations for relationship types.
reload() - Method in interface org.apache.syncope.common.rest.api.service.ConnectorService
Reload all connector bundles and instances.
removeConsoleLayoutInfo(String) - Method in interface org.apache.syncope.common.rest.api.service.RoleService
Removes the console layout information for the role with the given key, if available.
removeFormat(String, MailTemplateFormat) - Method in interface org.apache.syncope.common.rest.api.service.MailTemplateService
Removes the template for the given key and format, if available.
removeFormat(String, ReportTemplateFormat) - Method in interface org.apache.syncope.common.rest.api.service.ReportTemplateService
Removes the template for the given key and format, if available.
removeSyncToken(String, String) - Method in interface org.apache.syncope.common.rest.api.service.ResourceService
Removes the sync token value associated to the given any type from the given resource.
ReportService - Interface in org.apache.syncope.common.rest.api.service
REST operations for reports.
ReportTemplateService - Interface in org.apache.syncope.common.rest.api.service
REST operations for report templates.
requestPasswordReset(String, String) - Method in interface org.apache.syncope.common.rest.api.service.UserSelfService
Provides answer for the security question configured for user matching the given username, if any.
resource(String) - Method in class org.apache.syncope.common.rest.api.beans.TaskQuery.Builder
 
RESOURCE_KEY - Static variable in class org.apache.syncope.common.rest.api.RESTHeaders
 
ResourceHistoryService - Interface in org.apache.syncope.common.rest.api.service
REST operations for resource configuration versioning.
ResourceService - Interface in org.apache.syncope.common.rest.api.service
REST operations for external resources.
RESTHeaders - Class in org.apache.syncope.common.rest.api
Custom HTTP headers in use with REST services.
restore(String) - Method in interface org.apache.syncope.common.rest.api.service.ConnectorHistoryService
Restores the connector configuration history instance matching the provided key.
restore(String) - Method in interface org.apache.syncope.common.rest.api.service.ResourceHistoryService
Restores the resource configuration history matching the provided key.
RoleService - Interface in org.apache.syncope.common.rest.api.service
REST operations for roles.

S

SchemaQuery - Class in org.apache.syncope.common.rest.api.beans
 
SchemaQuery() - Constructor for class org.apache.syncope.common.rest.api.beans.SchemaQuery
 
SchemaQuery.Builder - Class in org.apache.syncope.common.rest.api.beans
 
SchemaService - Interface in org.apache.syncope.common.rest.api.service
REST operations for attribute schemas.
search(AnyQuery) - Method in interface org.apache.syncope.common.rest.api.service.AnyObjectService
 
search(AnyQuery) - Method in interface org.apache.syncope.common.rest.api.service.AnyService
Returns a paged list of any objects matching the given query.
search(AnyQuery) - Method in interface org.apache.syncope.common.rest.api.service.GroupService
 
search(SchemaQuery) - Method in interface org.apache.syncope.common.rest.api.service.SchemaService
Returns a list of schemas matching the given query.
search(TaskQuery) - Method in interface org.apache.syncope.common.rest.api.service.TaskService
Returns a paged list of existing tasks matching the given query.
search(AnyQuery) - Method in interface org.apache.syncope.common.rest.api.service.UserService
 
searchAssignableGroups(String, String, int, int) - Method in interface org.apache.syncope.common.rest.api.service.SyncopeService
Returns the list of Groups, according to provided paging instructions, assignable to Users and Any Objects of the provided Realm.
SecurityQuestionService - Interface in org.apache.syncope.common.rest.api.service
REST operations for configuration.
set(AttrTO) - Method in interface org.apache.syncope.common.rest.api.service.ConfigurationService
Creates / updates the configuration parameter with the given schema.
set(String, String, String) - Method in interface org.apache.syncope.common.rest.api.service.WorkflowService
Imports the workflow definition for matching any object type, under the provided key.
setAnyTypeClasses(List<String>) - Method in class org.apache.syncope.common.rest.api.beans.SchemaQuery
 
setAnyTypeKind(AnyTypeKind) - Method in class org.apache.syncope.common.rest.api.beans.TaskQuery
 
setConsoleLayoutInfo(String, InputStream) - Method in interface org.apache.syncope.common.rest.api.service.RoleService
Sets the console layout information as JSON string for the role with the given key, if available.
setDetails(Boolean) - Method in class org.apache.syncope.common.rest.api.beans.AnyQuery
 
setDetails(Boolean) - Method in class org.apache.syncope.common.rest.api.beans.TaskQuery
 
setDryRun(Boolean) - Method in class org.apache.syncope.common.rest.api.beans.ExecuteQuery
 
setEndedAfter(Date) - Method in class org.apache.syncope.common.rest.api.beans.BulkExecDeleteQuery
 
setEndedBefore(Date) - Method in class org.apache.syncope.common.rest.api.beans.BulkExecDeleteQuery
 
setEntityKey(String) - Method in class org.apache.syncope.common.rest.api.beans.TaskQuery
 
setFiql(String) - Method in class org.apache.syncope.common.rest.api.beans.AnyQuery
 
setFormat(String, MailTemplateFormat, InputStream) - Method in interface org.apache.syncope.common.rest.api.service.MailTemplateService
Sets the template for the given key and format, if available.
setFormat(String, ReportTemplateFormat, InputStream) - Method in interface org.apache.syncope.common.rest.api.service.ReportTemplateService
Sets the template for the given key and format, if available.
setKey(String) - Method in class org.apache.syncope.common.rest.api.beans.BulkExecDeleteQuery
 
setKey(String) - Method in class org.apache.syncope.common.rest.api.beans.ExecQuery
 
setKey(String) - Method in class org.apache.syncope.common.rest.api.beans.ExecuteQuery
 
setKeyword(String) - Method in class org.apache.syncope.common.rest.api.beans.SchemaQuery
 
setLatestSyncToken(String, String) - Method in interface org.apache.syncope.common.rest.api.service.ResourceService
Queries the connector underlying the given resource for the latest sync token value associated to the given any type and stores the value internally, for later usage.
setNotification(String) - Method in class org.apache.syncope.common.rest.api.beans.TaskQuery
 
setOrderBy(String) - Method in class org.apache.syncope.common.rest.api.beans.AbstractQuery
 
setOrderBy(String) - Method in class org.apache.syncope.common.rest.api.beans.ConnObjectTOListQuery
 
setPage(Integer) - Method in class org.apache.syncope.common.rest.api.beans.AbstractQuery
 
setPagedResultsCookie(String) - Method in class org.apache.syncope.common.rest.api.beans.ConnObjectTOListQuery
 
setRealm(String) - Method in class org.apache.syncope.common.rest.api.beans.AnyQuery
 
setResource(String) - Method in class org.apache.syncope.common.rest.api.beans.TaskQuery
 
setSize(Integer) - Method in class org.apache.syncope.common.rest.api.beans.AbstractQuery
 
setSize(Integer) - Method in class org.apache.syncope.common.rest.api.beans.ConnObjectTOListQuery
 
setStartAt(Date) - Method in class org.apache.syncope.common.rest.api.beans.ExecuteQuery
 
setStartedAfter(Date) - Method in class org.apache.syncope.common.rest.api.beans.BulkExecDeleteQuery
 
setStartedBefore(Date) - Method in class org.apache.syncope.common.rest.api.beans.BulkExecDeleteQuery
 
setType(SchemaType) - Method in class org.apache.syncope.common.rest.api.beans.SchemaQuery
 
setType(TaskType) - Method in class org.apache.syncope.common.rest.api.beans.TaskQuery
 
size(Integer) - Method in class org.apache.syncope.common.rest.api.beans.AbstractQuery.Builder
 
size(Integer) - Method in class org.apache.syncope.common.rest.api.beans.ConnObjectTOListQuery.Builder
 
startAt(Date) - Method in class org.apache.syncope.common.rest.api.beans.ExecuteQuery.Builder
 
startedAfter(Date) - Method in class org.apache.syncope.common.rest.api.beans.BulkExecDeleteQuery.Builder
 
startedBefore(Date) - Method in class org.apache.syncope.common.rest.api.beans.BulkExecDeleteQuery.Builder
 
status(AnyTypeKind, String, String) - Method in interface org.apache.syncope.common.rest.api.service.ReconciliationService
Gets current attributes on Syncope and on the given External Resource, related to given user, group or any object.
status(StatusPatch) - Method in interface org.apache.syncope.common.rest.api.service.UserSelfService
Self-perform a status update.
status(StatusPatch) - Method in interface org.apache.syncope.common.rest.api.service.UserService
Performs a status update on given user.
submitForm(WorkflowFormTO) - Method in interface org.apache.syncope.common.rest.api.service.UserWorkflowService
Submits a workflow form.
SyncopeService - Interface in org.apache.syncope.common.rest.api.service
General info about this Apache Syncope deployment.
system() - Method in interface org.apache.syncope.common.rest.api.service.SyncopeService
Provides information about the underlying system (Operating System, CPU / memory usage, ...).

T

TaskQuery - Class in org.apache.syncope.common.rest.api.beans
 
TaskQuery() - Constructor for class org.apache.syncope.common.rest.api.beans.TaskQuery
 
TaskQuery.Builder - Class in org.apache.syncope.common.rest.api.beans
 
TaskService - Interface in org.apache.syncope.common.rest.api.service
REST operations for tasks.
TOKEN - Static variable in class org.apache.syncope.common.rest.api.RESTHeaders
 
TOKEN_EXPIRE - Static variable in class org.apache.syncope.common.rest.api.RESTHeaders
 
toString() - Method in class org.apache.syncope.common.rest.api.beans.ConnObjectTOListQuery
 
toString() - Method in enum org.apache.syncope.common.rest.api.Preference
 
type(SchemaType) - Method in class org.apache.syncope.common.rest.api.beans.SchemaQuery.Builder
 

U

unclaimForm(String) - Method in interface org.apache.syncope.common.rest.api.service.UserWorkflowService
Unclaims the form for the given task id.
unwrap(Collection<AuditLoggerName>) - Static method in class org.apache.syncope.common.rest.api.LoggerWrapper
 
update(AnyObjectPatch) - Method in interface org.apache.syncope.common.rest.api.service.AnyObjectService
Updates any object matching the provided key.
update(AnyObjectTO) - Method in interface org.apache.syncope.common.rest.api.service.AnyObjectService
Updates any object matching the provided key.
update(String, SchemaType, AttrTO) - Method in interface org.apache.syncope.common.rest.api.service.AnyService
Adds or replaces the attribute, owned by the given any object, for the given schema type and schema.
update(AnyTypeClassTO) - Method in interface org.apache.syncope.common.rest.api.service.AnyTypeClassService
Updates the anyTypeClass matching the provided key.
update(AnyTypeTO) - Method in interface org.apache.syncope.common.rest.api.service.AnyTypeService
Updates the anyType matching the provided key.
update(ConnInstanceTO) - Method in interface org.apache.syncope.common.rest.api.service.ConnectorService
Updates the connector instance matching the provided key.
update(DomainTO) - Method in interface org.apache.syncope.common.rest.api.service.DomainService
Updates the domain matching the provided key.
update(DynRealmTO) - Method in interface org.apache.syncope.common.rest.api.service.DynRealmService
Updates the dynamic realm matching the provided key.
update(GroupPatch) - Method in interface org.apache.syncope.common.rest.api.service.GroupService
Updates group matching the provided key.
update(GroupTO) - Method in interface org.apache.syncope.common.rest.api.service.GroupService
Updates group matching the provided key.
update(LoggerType, LoggerTO) - Method in interface org.apache.syncope.common.rest.api.service.LoggerService
Creates or updates (if existing) the logger with matching name.
update(NotificationTO) - Method in interface org.apache.syncope.common.rest.api.service.NotificationService
Updates the notification matching the given key.
update(PolicyType, PolicyTO) - Method in interface org.apache.syncope.common.rest.api.service.PolicyService
Updates policy matching the given key.
update(RealmTO) - Method in interface org.apache.syncope.common.rest.api.service.RealmService
Updates the realm under the given path.
update(RelationshipTypeTO) - Method in interface org.apache.syncope.common.rest.api.service.RelationshipTypeService
Updates the relationshipType matching the provided key.
update(ReportTO) - Method in interface org.apache.syncope.common.rest.api.service.ReportService
Updates report with matching key.
update(ResourceTO) - Method in interface org.apache.syncope.common.rest.api.service.ResourceService
Updates the resource matching the given name.
update(RoleTO) - Method in interface org.apache.syncope.common.rest.api.service.RoleService
Updates the role matching the provided key.
update(SchemaType, SchemaTO) - Method in interface org.apache.syncope.common.rest.api.service.SchemaService
Updates the schema matching the given type and key.
update(SecurityQuestionTO) - Method in interface org.apache.syncope.common.rest.api.service.SecurityQuestionService
Updates the security question matching the provided key.
update(TaskType, SchedTaskTO) - Method in interface org.apache.syncope.common.rest.api.service.TaskService
Updates the task matching the provided key.
update(UserPatch) - Method in interface org.apache.syncope.common.rest.api.service.UserSelfService
Self-updates user.
update(UserTO) - Method in interface org.apache.syncope.common.rest.api.service.UserSelfService
Self-updates user.
update(UserPatch) - Method in interface org.apache.syncope.common.rest.api.service.UserService
Updates user matching the provided key.
update(UserTO) - Method in interface org.apache.syncope.common.rest.api.service.UserService
Updates user matching the provided key.
UserSelfService - Interface in org.apache.syncope.common.rest.api.service
REST operations for user self-management.
UserService - Interface in org.apache.syncope.common.rest.api.service
REST operations for users.
UserWorkflowService - Interface in org.apache.syncope.common.rest.api.service
REST operations related to user workflow.

V

valueOf(String) - Static method in enum org.apache.syncope.common.rest.api.Preference
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.syncope.common.rest.api.Preference
Returns an array containing the constants of this enum type, in the order they are declared.

W

WorkflowFormQuery - Class in org.apache.syncope.common.rest.api.beans
 
WorkflowFormQuery() - Constructor for class org.apache.syncope.common.rest.api.beans.WorkflowFormQuery
 
WorkflowFormQuery.Builder - Class in org.apache.syncope.common.rest.api.beans
 
WorkflowService - Interface in org.apache.syncope.common.rest.api.service
REST operations for workflow definition.
wrap(Collection<LoggerTO>) - Static method in class org.apache.syncope.common.rest.api.LoggerWrapper
 
A B C D E F G H J K L M N O P R S T U V W 
Skip navigation links

Copyright © 2010–2020 The Apache Software Foundation. All rights reserved.