public class ConnectorInstanceIcfImpl extends Object implements ConnectorInstance
Constructor and Description |
---|
ConnectorInstanceIcfImpl(org.identityconnectors.framework.api.ConnectorInfo connectorInfo,
com.evolveum.midpoint.xml.ns._public.common.common_3.ConnectorType connectorType,
String schemaNamespace,
PrismSchema connectorSchema,
Protector protector,
PrismContext prismContext) |
Modifier and Type | Method and Description |
---|---|
Collection<ResourceAttribute<?>> |
addObject(PrismObject<? extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> object,
Collection<Operation> additionalOperations,
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,
OperationResult parentResult)
Counts objects on resource.
|
void |
deleteObject(ObjectClassComplexTypeDefinition objectClass,
Collection<Operation> additionalOperations,
Collection<? extends ResourceAttribute<?>> identifiers,
OperationResult parentResult) |
PrismProperty<?> |
deserializeToken(Object serializedToken)
Creates a live Java object from a token previously serialized to string.
|
Object |
executeScript(ExecuteProvisioningScriptOperation scriptOperation,
OperationResult parentResult) |
Collection<Object> |
fetchCapabilities(OperationResult parentResult)
Retrieves native connector capabilities.
|
<T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> |
fetchChanges(ObjectClassComplexTypeDefinition objectClass,
PrismProperty<?> lastToken,
AttributesToReturn attrsToReturn,
OperationResult parentResult)
Token may be null.
|
PrismProperty<?> |
fetchCurrentToken(ObjectClassComplexTypeDefinition objectClass,
OperationResult parentResult)
Returns the latest token.
|
<T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> |
fetchObject(Class<T> type,
ObjectClassComplexTypeDefinition objectClassDefinition,
Collection<? extends ResourceAttribute<?>> identifiers,
AttributesToReturn attributesToReturn,
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() |
IcfNameMapper |
getIcfNameMapper() |
String |
getSchemaNamespace() |
void |
initialize(ResourceSchema resourceSchema,
Collection<Object> capabilities,
boolean caseIgnoreAttributeNames,
OperationResult parentResult)
Get necessary information from the remote system.
|
Set<PropertyModificationOperation> |
modifyObject(ObjectClassComplexTypeDefinition objectClass,
Collection<? extends ResourceAttribute<?>> identifiers,
Collection<Operation> changes,
OperationResult parentResult)
TODO: This should return indication how the operation went, e.g.
|
<T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> |
search(ObjectClassComplexTypeDefinition objectClassDefinition,
ObjectQuery query,
ResultHandler<T> handler,
AttributesToReturn attributesToReturn,
com.evolveum.midpoint.xml.ns._public.resource.capabilities_3.PagedSearchCapabilityType pagedSearchCapabilityType,
OperationResult parentResult)
Execute iterative search operation.
|
void |
setDescription(String description) |
void |
setIcfNameMapper(IcfNameMapper icfNameMapper) |
void |
test(OperationResult parentResult) |
String |
toString() |
public ConnectorInstanceIcfImpl(org.identityconnectors.framework.api.ConnectorInfo connectorInfo, com.evolveum.midpoint.xml.ns._public.common.common_3.ConnectorType connectorType, String schemaNamespace, PrismSchema connectorSchema, Protector protector, PrismContext prismContext)
public String getDescription()
public void setDescription(String description)
public String getSchemaNamespace()
public IcfNameMapper getIcfNameMapper()
public void setIcfNameMapper(IcfNameMapper icfNameMapper)
public void configure(PrismContainerValue<?> configuration, OperationResult parentResult) throws CommunicationException, GenericFrameworkException, SchemaException, ConfigurationException
ConnectorInstance
configure
in interface ConnectorInstance
ConfigurationException
CommunicationException
GenericFrameworkException
SchemaException
public PrismSchema generateConnectorSchema()
generateConnectorSchema
in interface ConnectorInstance
public void initialize(ResourceSchema resourceSchema, Collection<Object> capabilities, boolean caseIgnoreAttributeNames, OperationResult parentResult) throws CommunicationException, GenericFrameworkException, ConfigurationException
ConnectorInstance
initialize
in interface ConnectorInstance
CommunicationException
GenericFrameworkException
ConfigurationException
public ResourceSchema fetchResourceSchema(List<QName> generateObjectClasses, OperationResult parentResult) throws CommunicationException, GenericFrameworkException, ConfigurationException
ConnectorInstance
fetchResourceSchema
in interface ConnectorInstance
CommunicationException
- error in communication to the resource
- nothing was fetched.ConfigurationException
GenericFrameworkException
PrismSchema
public Collection<Object> fetchCapabilities(OperationResult parentResult) throws CommunicationException, GenericFrameworkException, ConfigurationException
ConnectorInstance
fetchCapabilities
in interface ConnectorInstance
CommunicationException
GenericFrameworkException
ConfigurationException
public <T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> PrismObject<T> fetchObject(Class<T> type, ObjectClassComplexTypeDefinition objectClassDefinition, Collection<? extends ResourceAttribute<?>> identifiers, AttributesToReturn attributesToReturn, OperationResult parentResult) throws ObjectNotFoundException, CommunicationException, GenericFrameworkException, SchemaException, SecurityViolationException, ConfigurationException
ConnectorInstance
fetchObject
in interface ConnectorInstance
identifiers
- primary identifiers of the object.CommunicationException
- error in communication to the resource
- nothing was fetched.SchemaException
- error converting object from native (connector) formatObjectNotFoundException
GenericFrameworkException
SecurityViolationException
ConfigurationException
public Collection<ResourceAttribute<?>> addObject(PrismObject<? extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> object, Collection<Operation> additionalOperations, OperationResult parentResult) throws CommunicationException, GenericFrameworkException, SchemaException, ObjectAlreadyExistsException, ConfigurationException
ConnectorInstance
addObject
in interface ConnectorInstance
CommunicationException
SchemaException
- resource schema violationObjectAlreadyExistsException
- object already exists on the resourceGenericFrameworkException
ConfigurationException
public Set<PropertyModificationOperation> modifyObject(ObjectClassComplexTypeDefinition objectClass, Collection<? extends ResourceAttribute<?>> identifiers, Collection<Operation> changes, OperationResult parentResult) throws ObjectNotFoundException, CommunicationException, GenericFrameworkException, SchemaException, SecurityViolationException, ObjectAlreadyExistsException
ConnectorInstance
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.CommunicationException
SchemaException
ObjectAlreadyExistsException
- in case that the modified object conflicts with another existing object (e.g. while renaming an object)ObjectNotFoundException
GenericFrameworkException
SecurityViolationException
public void deleteObject(ObjectClassComplexTypeDefinition objectClass, Collection<Operation> additionalOperations, Collection<? extends ResourceAttribute<?>> identifiers, OperationResult parentResult) throws ObjectNotFoundException, CommunicationException, GenericFrameworkException
deleteObject
in interface ConnectorInstance
ObjectNotFoundException
CommunicationException
GenericFrameworkException
public PrismProperty<?> deserializeToken(Object serializedToken)
ConnectorInstance
deserializeToken
in interface ConnectorInstance
public PrismProperty<?> fetchCurrentToken(ObjectClassComplexTypeDefinition objectClass, OperationResult parentResult) throws CommunicationException, GenericFrameworkException
ConnectorInstance
fetchCurrentToken
in interface ConnectorInstance
CommunicationException
GenericFrameworkException
public <T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> List<Change<T>> fetchChanges(ObjectClassComplexTypeDefinition objectClass, PrismProperty<?> lastToken, AttributesToReturn attrsToReturn, OperationResult parentResult) throws CommunicationException, GenericFrameworkException, SchemaException, ConfigurationException
ConnectorInstance
fetchChanges
in interface ConnectorInstance
CommunicationException
GenericFrameworkException
SchemaException
ConfigurationException
public void test(OperationResult parentResult)
test
in interface ConnectorInstance
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, OperationResult parentResult) throws CommunicationException, GenericFrameworkException, SchemaException
ConnectorInstance
search
in interface ConnectorInstance
CommunicationException
SchemaException
- error converting object from the native (connector) formatGenericFrameworkException
public int count(ObjectClassComplexTypeDefinition objectClassDefinition, ObjectQuery query, com.evolveum.midpoint.xml.ns._public.resource.capabilities_3.PagedSearchCapabilityType pagedSearchCapabilityType, OperationResult parentResult) throws CommunicationException, GenericFrameworkException, SchemaException, UnsupportedOperationException
ConnectorInstance
count
in interface ConnectorInstance
CommunicationException
SchemaException
UnsupportedOperationException
GenericFrameworkException
public Object executeScript(ExecuteProvisioningScriptOperation scriptOperation, OperationResult parentResult) throws CommunicationException, GenericFrameworkException
executeScript
in interface ConnectorInstance
CommunicationException
GenericFrameworkException
public String getHumanReadableName()
Copyright © 2015 evolveum. All rights reserved.