ConnectorInstanceIcfImpl (midPoint Project 3.4.1 API)

java.lang.Object
- com.evolveum.midpoint.provisioning.ucf.impl.ConnectorInstanceIcfImpl

All Implemented Interfaces:

ConnectorInstance
```
public class ConnectorInstanceIcfImpl
extends Object
implements ConnectorInstance
```
Implementation of ConnectorInstance for ICF connectors.
This class implements the ConnectorInstance interface. The methods are converting the data from the "midPoint semantics" as seen by the ConnectorInstance interface to the "ICF semantics" as seen by the ICF framework.

Author:

Radovan Semancik

Method Summary

Methods
Modifier and Type	Method and Description
`Collection<ResourceAttribute<?>>`	`addObject(PrismObject<? extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> shadow, Collection<Operation> additionalOperations, StateReporter reporter, OperationResult parentResult)` TODO: This should return indication how the operation went, e.g.
`void`	`configure(PrismContainerValue<?> configuration, OperationResult parentResult)` The connector instance will be configured to the state that it can immediately access the resource.
`int`	`count(ObjectClassComplexTypeDefinition objectClassDefinition, ObjectQuery query, com.evolveum.midpoint.xml.ns._public.resource.capabilities_3.PagedSearchCapabilityType pagedSearchCapabilityType, StateReporter reporter, OperationResult parentResult)` Counts objects on resource.
`void`	`deleteObject(ObjectClassComplexTypeDefinition objectClass, Collection<Operation> additionalOperations, Collection<? extends ResourceAttribute<?>> identifiers, StateReporter reporter, OperationResult parentResult)`
`PrismProperty<?>`	`deserializeToken(Object serializedToken)` Creates a live Java object from a token previously serialized to string.
`void`	`dispose()`
`Object`	`executeScript(ExecuteProvisioningScriptOperation scriptOperation, StateReporter reporter, OperationResult parentResult)`
`Collection<Object>`	`fetchCapabilities(OperationResult parentResult)` Retrieves native connector capabilities.
`<T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> List<Change<T>>`	`fetchChanges(ObjectClassComplexTypeDefinition objectClass, PrismProperty<?> lastToken, AttributesToReturn attrsToReturn, StateReporter reporter, OperationResult parentResult)` Token may be null.
`<T> PrismProperty<T>`	`fetchCurrentToken(ObjectClassComplexTypeDefinition objectClassDef, StateReporter reporter, OperationResult parentResult)` Returns the latest token.
`<T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> PrismObject<T>`	`fetchObject(Class<T> type, ResourceObjectIdentification resourceObjectIdentification, AttributesToReturn attributesToReturn, StateReporter reporter, OperationResult parentResult)` Retrieves a specific object from the resource.
`ResourceSchema`	`fetchResourceSchema(List<QName> generateObjectClasses, OperationResult parentResult)` Retrieves the schema from the resource.
`PrismSchema`	`generateConnectorSchema()`
`String`	`getDescription()`
`String`	`getHumanReadableName()`
`ConnectorOperationalStatus`	`getOperationalStatus()`
`String`	`getSchemaNamespace()`
`void`	`initialize(ResourceSchema resourceSchema, Collection<Object> capabilities, boolean caseIgnoreAttributeNames, OperationResult parentResult)` Get necessary information from the remote system.
`Set<PropertyModificationOperation>`	`modifyObject(ObjectClassComplexTypeDefinition objectClassDef, Collection<? extends ResourceAttribute<?>> identifiers, Collection<Operation> changes, StateReporter reporter, OperationResult parentResult)` TODO: This should return indication how the operation went, e.g.
`void`	`resetResourceSchema()`
`<T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> SearchResultMetadata`	`search(ObjectClassComplexTypeDefinition objectClassDefinition, ObjectQuery query, ResultHandler<T> handler, AttributesToReturn attributesToReturn, com.evolveum.midpoint.xml.ns._public.resource.capabilities_3.PagedSearchCapabilityType pagedSearchCapabilityType, SearchHierarchyConstraints searchHierarchyConstraints, StateReporter reporter, OperationResult parentResult)` Execute iterative search operation.
`void`	`setDescription(String description)`
`void`	`setResourceSchema(ResourceSchema resourceSchema)`
`void`	`test(OperationResult parentResult)`
`String`	`toString()`

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

Method Detail

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

getSchemaNamespace
```
public String getSchemaNamespace()
```

setResourceSchema

public void setResourceSchema(ResourceSchema resourceSchema)

resetResourceSchema
```
public void resetResourceSchema()
```

configure
```
public void configure(PrismContainerValue<?> configuration,
             OperationResult parentResult)
               throws CommunicationException,
                      GenericFrameworkException,
                      SchemaException,
                      ConfigurationException
```
Description copied from interface: ConnectorInstance

The connector instance will be configured to the state that it can immediately access the resource. The resource configuration is provided as a parameter to this method.

Specified by:

configure in interface ConnectorInstance

Throws:

ConfigurationException

CommunicationException

GenericFrameworkException

SchemaException

generateConnectorSchema
```
public PrismSchema generateConnectorSchema()
```
Specified by:

generateConnectorSchema in interface ConnectorInstance

getOperationalStatus

public ConnectorOperationalStatus getOperationalStatus()
                                                throws ObjectNotFoundException

Specified by:: getOperationalStatus in interface ConnectorInstance
Throws:: ObjectNotFoundException

initialize
```
public void initialize(ResourceSchema resourceSchema,
              Collection<Object> capabilities,
              boolean caseIgnoreAttributeNames,
              OperationResult parentResult)
                throws CommunicationException,
                       GenericFrameworkException,
                       ConfigurationException
```
Description copied from interface: ConnectorInstance

Get necessary information from the remote system. This method will initialize the configured connector. It may contact the remote system in order to do so, e.g. to download the schema. It will the cache the information inside connector instance until this method is called again. It must be called after configure() and before any other method that is accessing the resource. If resource schema and capabilities are already cached by midPoint they may be passed to the connector instance. Otherwise the instance may need to fetch them from the resource which may be less efficient.

Specified by:

initialize in interface ConnectorInstance

Throws:

CommunicationException

GenericFrameworkException

ConfigurationException

fetchResourceSchema
```
public ResourceSchema fetchResourceSchema(List<QName> generateObjectClasses,
                                 OperationResult parentResult)
                                   throws CommunicationException,
                                          GenericFrameworkException,
                                          ConfigurationException
```
Description copied from interface: ConnectorInstance

Retrieves the schema from the resource. The schema may be considered to be an XSD schema, but it is returned in a "parsed" format and it is in fact a bit stricter and richer midPoint schema. It may return null. Such case means that the schema cannot be determined.

Specified by:

fetchResourceSchema in interface ConnectorInstance

Returns:
Up-to-date resource schema.

Throws:

CommunicationException - error in communication to the resource - nothing was fetched.

ConfigurationException

GenericFrameworkException
See Also:
PrismSchema

fetchCapabilities
```
public Collection<Object> fetchCapabilities(OperationResult parentResult)
                                     throws CommunicationException,
                                            GenericFrameworkException,
                                            ConfigurationException
```
Description copied from interface: ConnectorInstance

Retrieves native connector capabilities. The capabilities specify what the connector can do without any kind of simulation or other workarounds. The set of capabilities may depend on the connector configuration (e.g. if a "disable" or password attribute was specified in the configuration or not). It may return null. Such case means that the capabilities cannot be determined.

Specified by:

fetchCapabilities in interface ConnectorInstance

Returns:

Throws:

CommunicationException

GenericFrameworkException

ConfigurationException

fetchObject

public <T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> PrismObject<T> fetchObject(Class<T> type,
                                                                                                     ResourceObjectIdentification resourceObjectIdentification,
                                                                                                     AttributesToReturn attributesToReturn,
                                                                                                     StateReporter reporter,
                                                                                                     OperationResult parentResult)
                                                                                                   throws ObjectNotFoundException,
                                                                                                          CommunicationException,
                                                                                                          GenericFrameworkException,
                                                                                                          SchemaException,
                                                                                                          SecurityViolationException,
                                                                                                          ConfigurationException

Description copied from interface: ConnectorInstance

Retrieves a specific object from the resource. This method is fetching an object from the resource that is identified by its primary identifier. It is a "targeted" method in this aspect and it will fail if the object is not found. The objectClass provided as a parameter to this method must correspond to one of the object classes in the schema. The object class must match the object. If it does not, the behavior of this operation is undefined. The returned ResourceObject is "disconnected" from schema. It means that any call to the getDefinition() method of the returned object will return null. TODO: object not found error

Specified by:: fetchObject in interface ConnectorInstance
Returns:: object fetched from the resource (no schema)
Throws:: CommunicationException - error in communication to the resource - nothing was fetched.; SchemaException - error converting object from native (connector) format; ObjectNotFoundException; GenericFrameworkException; SecurityViolationException; ConfigurationException

addObject
```
public Collection<ResourceAttribute<?>> addObject(PrismObject<? extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> shadow,
                                         Collection<Operation> additionalOperations,
                                         StateReporter reporter,
                                         OperationResult parentResult)
                                           throws CommunicationException,
                                                  GenericFrameworkException,
                                                  SchemaException,
                                                  ObjectAlreadyExistsException,
                                                  ConfigurationException
```
Description copied from interface: ConnectorInstance

TODO: This should return indication how the operation went, e.g. what changes were applied, what were not and what were not determined. The exception should be thrown only if the connector is sure that nothing was done on the resource. E.g. in case of connect timeout or connection refused. Timeout during operation should not cause the exception as something might have been done already. The connector may return some (or all) of the attributes of created object. The connector should do this only such operation is efficient, e.g. in case that the created object is normal return value from the create operation. The connector must not execute additional operation to fetch the state of created resource. In case that the new state is not such a normal result, the connector must return null. Returning empty set means that the connector supports returning of new state, but nothing was returned (e.g. due to a limiting configuration). Returning null means that connector does not support returning of new object state and the caller should explicitly invoke fetchObject() in case that the information is needed.

Specified by:

addObject in interface ConnectorInstance

Returns:
created object attributes. May be null.

Throws:

CommunicationException

SchemaException - resource schema violation

ObjectAlreadyExistsException - object already exists on the resource

GenericFrameworkException

ConfigurationException

modifyObject

public Set<PropertyModificationOperation> modifyObject(ObjectClassComplexTypeDefinition objectClassDef,
                                              Collection<? extends ResourceAttribute<?>> identifiers,
                                              Collection<Operation> changes,
                                              StateReporter reporter,
                                              OperationResult parentResult)
                                                throws ObjectNotFoundException,
                                                       CommunicationException,
                                                       GenericFrameworkException,
                                                       SchemaException,
                                                       SecurityViolationException,
                                                       ObjectAlreadyExistsException

Description copied from interface: ConnectorInstance

TODO: This should return indication how the operation went, e.g. what changes were applied, what were not and what results are we not sure about. Returns a set of attributes that were changed as a result of the operation. This may include attributes that were changed as a side effect of the operations, e.g. attributes that were not originally specified in the "changes" parameter. The exception should be thrown only if the connector is sure that nothing was done on the resource. E.g. in case of connect timeout or connection refused. Timeout during operation should not cause the exception as something might have been done already.

Specified by:: modifyObject in interface ConnectorInstance; identifiers - The set of identifiers. Their values may change as a result of the operation, e.g. when the resource object is renamed.
Throws:: CommunicationException; SchemaException; ObjectAlreadyExistsException - in case that the modified object conflicts with another existing object (e.g. while renaming an object); ObjectNotFoundException; GenericFrameworkException; SecurityViolationException

deleteObject

public void deleteObject(ObjectClassComplexTypeDefinition objectClass,
                Collection<Operation> additionalOperations,
                Collection<? extends ResourceAttribute<?>> identifiers,
                StateReporter reporter,
                OperationResult parentResult)
                  throws ObjectNotFoundException,
                         CommunicationException,
                         GenericFrameworkException,
                         SchemaException

Specified by:: deleteObject in interface ConnectorInstance
Throws:: ObjectNotFoundException; CommunicationException; GenericFrameworkException; SchemaException

deserializeToken
```
public PrismProperty<?> deserializeToken(Object serializedToken)
```
Description copied from interface: ConnectorInstance

Creates a live Java object from a token previously serialized to string. Serialized token is not portable to other connectors or other resources. However, newer versions of the connector should understand tokens generated by previous connector version.

Specified by:

deserializeToken in interface ConnectorInstance

Returns:

fetchCurrentToken

public <T> PrismProperty<T> fetchCurrentToken(ObjectClassComplexTypeDefinition objectClassDef,
                                     StateReporter reporter,
                                     OperationResult parentResult)
                                   throws CommunicationException,
                                          GenericFrameworkException

Description copied from interface: ConnectorInstance

Returns the latest token. In other words, returns a token that corresponds to a current state of the resource. If fetchChanges is immediately called with this token, nothing should be returned (Figuratively speaking, neglecting concurrent resource modifications).

Specified by:: fetchCurrentToken in interface ConnectorInstance
Returns:
Throws:: CommunicationException; GenericFrameworkException

fetchChanges

public <T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> List<Change<T>> fetchChanges(ObjectClassComplexTypeDefinition objectClass,
                                                                                                       PrismProperty<?> lastToken,
                                                                                                       AttributesToReturn attrsToReturn,
                                                                                                       StateReporter reporter,
                                                                                                       OperationResult parentResult)
                                                                                                     throws CommunicationException,
                                                                                                            GenericFrameworkException,
                                                                                                            SchemaException,
                                                                                                            ConfigurationException

Description copied from interface: ConnectorInstance

Token may be null. That means "from the beginning of history".

Specified by:: fetchChanges in interface ConnectorInstance
Returns:
Throws:: CommunicationException; GenericFrameworkException; SchemaException; ConfigurationException

test

public void test(OperationResult parentResult)

Specified by:: test in interface ConnectorInstance

search

public <T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> SearchResultMetadata search(ObjectClassComplexTypeDefinition objectClassDefinition,
                                                                                                      ObjectQuery query,
                                                                                                      ResultHandler<T> handler,
                                                                                                      AttributesToReturn attributesToReturn,
                                                                                                      com.evolveum.midpoint.xml.ns._public.resource.capabilities_3.PagedSearchCapabilityType pagedSearchCapabilityType,
                                                                                                      SearchHierarchyConstraints searchHierarchyConstraints,
                                                                                                      StateReporter reporter,
                                                                                                      OperationResult parentResult)
                            throws CommunicationException,
                                   GenericFrameworkException,
                                   SecurityViolationException,
                                   SchemaException,
                                   ObjectNotFoundException

Description copied from interface: ConnectorInstance

Execute iterative search operation. This method will execute search operation on the resource and will pass any objects that are found. A "handler" callback will be called for each of the objects found. The call to this method will return only after all the callbacks were called, therefore it is not asynchronous in a strict sense. If nothing is found the method should behave as if there is an empty result set (handler is never called) and the call should result in a success. The ObjectNotFoundException should be throws only if there is an error in search parameters, e.g. if search base points to an non-existent object.

Specified by:: search in interface ConnectorInstance
Returns:
Throws:: CommunicationException; SchemaException - error converting object from the native (connector) format; ObjectNotFoundException - if something from the search parameters refers non-existent object. e.g. if search base points to an non-existent object.; GenericFrameworkException; SecurityViolationException

count

public int count(ObjectClassComplexTypeDefinition objectClassDefinition,
        ObjectQuery query,
        com.evolveum.midpoint.xml.ns._public.resource.capabilities_3.PagedSearchCapabilityType pagedSearchCapabilityType,
        StateReporter reporter,
        OperationResult parentResult)
          throws CommunicationException,
                 GenericFrameworkException,
                 SchemaException,
                 UnsupportedOperationException

Description copied from interface: ConnectorInstance

Counts objects on resource. This method will count objects on the resource by executing a paged search operation, returning the "estimated objects count" information. If paging is not available, it throws an exception.

Specified by:: count in interface ConnectorInstance
Throws:: CommunicationException; SchemaException; UnsupportedOperationException; GenericFrameworkException

executeScript

public Object executeScript(ExecuteProvisioningScriptOperation scriptOperation,
                   StateReporter reporter,
                   OperationResult parentResult)
                     throws CommunicationException,
                            GenericFrameworkException

Specified by:: executeScript in interface ConnectorInstance
Throws:: CommunicationException; GenericFrameworkException

toString
```
public String toString()
```
Overrides:

toString in class Object

getHumanReadableName
```
public String getHumanReadableName()
```

dispose
```
public void dispose()
```
Specified by:

dispose in interface ConnectorInstance

Class ConnectorInstanceIcfImpl

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getDescription

setDescription

getSchemaNamespace

setResourceSchema

resetResourceSchema

configure

generateConnectorSchema

getOperationalStatus

initialize

fetchResourceSchema

fetchCapabilities

fetchObject

addObject

modifyObject

deleteObject

deserializeToken

fetchCurrentToken

fetchChanges

test

search

count

executeScript

toString

getHumanReadableName

dispose