CommandServiceImpl (Apache Syncope 3.0.14 API)

java.lang.Object
- org.apache.syncope.core.rest.cxf.service.AbstractService
- - org.apache.syncope.core.rest.cxf.service.CommandServiceImpl

All Implemented Interfaces:: CommandService, JAXRSService

@Service
public class CommandServiceImpl
extends AbstractService
implements CommandService

Field Summary

Fields
Modifier and Type Field Description

protected CommandLogic logic
- Fields inherited from class org.apache.syncope.core.rest.cxf.service.AbstractService
  LOG, messageContext, OPTIONS_ALLOW, searchContext, uriInfo
- 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

Constructor Summary

Constructors
Constructor Description

CommandServiceImpl(CommandLogic logic)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CommandTO`	`read(String key)`	Returns the command for the given key, if found.
`CommandOutput`	`run(CommandTO command)`	Runs the given command with the given arguments and returns the resulting output.
`PagedResult<CommandTO>`	`search(CommandQuery query)`	Returns a paged list of all commands.

Methods inherited from class org.apache.syncope.core.rest.cxf.service.AbstractService
applyPreference, buildPagedResult, checkETag, createResponse, findActualKey, getOrderByClauses, getPreference, isNullPriorityAsync, modificationResponse

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - logic
```
protected final CommandLogic logic
```
- Constructor Detail
  - CommandServiceImpl
```
public CommandServiceImpl(CommandLogic logic)
```
- Method Detail
  - search
```
public PagedResult<CommandTO> search(CommandQuery query)
```
    Description copied from interface: CommandService
    
    Returns a paged list of all commands.
    
    Specified by:
    
    search in interface CommandService
    
    Parameters:
    
    query - query conditions
    
    Returns:
    
    list of all commands.
  - read
```
public CommandTO read(String key)
```
    Description copied from interface: CommandService
    
    Returns the command for the given key, if found.
    
    Specified by:
    
    read in interface CommandService
    
    Parameters:
    
    key - command key
    
    Returns:
    
    the command for the given key, if found
  - run
```
public CommandOutput run(CommandTO command)
```
    Description copied from interface: CommandService
    
    Runs the given command with the given arguments and returns the resulting output.
    
    Specified by:
    
    run in interface CommandService
    
    Parameters:
    
    command - command to run, with arguments
    
    Returns:
    
    command output