Package com.evolveum.midpoint.smart.api.conndev

Interface ConnectorDevelopmentOperation

public interface ConnectorDevelopmentOperation

Method Summary

Modifier and Type	Method	Description
void	authenticationSelectionUpdated(Task task, OperationResult result)
void	basicConnectorInfoUpdated(ConnectorDevelopmentType updated)
StatusInfo<PrismContainer<ConnDevBasicObjectClassInfoType>>	discoverObjectClasses()
StatusInfo<PrismContainer<ConnDevAttributeInfoType>>	generateAttributes(ConnDevBasicObjectClassInfoType type)
StatusInfo<ConnDevArtifactType>	generateNativeSchemaScript(PrismContainer<ConnDevAttributeInfoType> type)
StatusInfo<ConnDevArtifactType>	generateSearchAll(String objectClass, ConnDevHttpEndpointType endpoint)
String	getArtifactContent(ConnDevArtifactType type, Task task, OperationResult result)
ConnectorDevelopmentType	getObject()
StatusInfo<PrismContainer<ConnDevHttpEndpointType>>	getSearchEndpoints(String objectClass)
StatusInfo<ConnectorDevelopmentType>	processDocumentation(PrismContainer<ConnDevDocumentationSourceType> sources)
void	resetResourceSchema(Task task, OperationResult result)
void	saveArtifact(ConnDevArtifactType endpoint, Task task, OperationResult result)
default void	saveAuthenticationScript(ConnDevArtifactType artifact, Task task, OperationResult result)
default void	saveConnIdSchemaScript(ConnDevArtifactType artifact, Task task, OperationResult result)
default void	saveGetByIdScript(ConnDevArtifactType artifact, Task task, OperationResult result)
default void	saveNativeSchemaScript(ConnDevArtifactType artifact, Task task, OperationResult result)
default void	saveRelationScript(ConnDevArtifactType endpoint, Task task, OperationResult result)
default void	saveSearchAllScript(ConnDevArtifactType artifact, Task task, OperationResult result)
default void	saveSearchFilterScript(ConnDevArtifactType artifact, Task task, OperationResult result)
StatusInfo<PrismContainer<ConnDevAuthInfoType>>	selectBaseApiInformation(String basicInfo)
String	submitCreateConnector(Task task, OperationResult result)
String	submitDiscoverBasicInformation(Task task, OperationResult result)
String	submitDiscoverConnectivityEndpoint(Task task, OperationResult result)
String	submitDiscoverDocumentation(Task task, OperationResult result)
String	submitDiscoverObjectClassAttributes(String objectClass, Task testTask, OperationResult testOperationResult)
String	submitDiscoverObjectClassDetails(String objectClass, Task testTask, OperationResult testOperationResult)
String	submitDiscoverObjectClassEndpoints(String objectClass, Task testTask, OperationResult testOperationResult)
String	submitDiscoverObjectClasses(Task task, OperationResult result)
String	submitGenerateArtifact(ConnDevArtifactType artifact, boolean retry, Task testTask, OperationResult testOperationResult)
String	submitGenerateArtifact(ConnDevArtifactType artifact, Consumer<ConnDevGenerateArtifactDefinitionType> customizer, boolean retry, Task task, OperationResult result)
default String	submitGenerateAuthenticationScript(boolean retry, Task task, OperationResult result)
default String	submitGenerateConnIdSchema(String objectClass, boolean retry, Task testTask, OperationResult testOperationResult)
default String	submitGenerateCreateScript(String objectClass, List<ConnDevHttpEndpointType> endpoints, boolean retry, Task task, OperationResult result)
default String	submitGenerateDeleteScript(String objectClass, List<ConnDevHttpEndpointType> endpoints, boolean retry, Task task, OperationResult result)
default String	submitGenerateEndpointBasedScript(ConnectorDevelopmentArtifacts.KnownArtifactType artifactDef, String objectClass, List<ConnDevHttpEndpointType> endpoints, boolean retry, Task task, OperationResult result)
default String	submitGenerateNativeSchema(String objectClass, boolean retry, Task task, OperationResult result)
default String	submitGenerateRelationScript(ConnDevRelationInfoType relation, boolean retry, Task task, OperationResult result)
default String	submitGenerateSearchByIdScript(String objectClass, List<ConnDevHttpEndpointType> endpoints, boolean retry, Task task, OperationResult result)
default String	submitGenerateSearchFilterScript(String objectClass, List<ConnDevHttpEndpointType> endpoints, boolean retry, Task task, OperationResult result)
default String	submitGenerateSearchScript(String objectClass, List<ConnDevHttpEndpointType> endpoints, boolean retry, Task task, OperationResult result)
default String	submitGenerateUpdateScript(String objectClass, List<ConnDevHttpEndpointType> endpoints, boolean retry, Task task, OperationResult result)
String	submitProcessDocumentation(Task task, OperationResult result)
String	submitRefreshScimSchema(Task task, OperationResult result)
List<ConnDevHttpEndpointType>	suggestedEndpointsFor(String objectClass, ConnectorDevelopmentArtifacts.KnownArtifactType knownArtifactType)
ResourceType	testConnection(ConnectorConfigurationType type)
BareResourceSchema	testSchema(ConnDevArtifactType type)
void	testSearchAll(String objectClass, ConnDevArtifactType script)

Method Details

getObject

ConnectorDevelopmentType getObject()

submitDiscoverDocumentation

String submitDiscoverDocumentation(Task task,
 OperationResult result)

submitProcessDocumentation

String submitProcessDocumentation(Task task,
 OperationResult result)

processDocumentation

StatusInfo<ConnectorDevelopmentType> processDocumentation(PrismContainer<ConnDevDocumentationSourceType> sources)

submitDiscoverBasicInformation

String submitDiscoverBasicInformation(Task task,
 OperationResult result)

submitDiscoverConnectivityEndpoint

String submitDiscoverConnectivityEndpoint(Task task,
 OperationResult result)

basicConnectorInfoUpdated

void basicConnectorInfoUpdated(ConnectorDevelopmentType updated)

selectBaseApiInformation

StatusInfo<PrismContainer<ConnDevAuthInfoType>> selectBaseApiInformation(String basicInfo)

submitCreateConnector

String submitCreateConnector(Task task,
 OperationResult result)

submitDiscoverObjectClasses

String submitDiscoverObjectClasses(Task task,
 OperationResult result)

submitDiscoverObjectClassDetails

String submitDiscoverObjectClassDetails(String objectClass,
 Task testTask,
 OperationResult testOperationResult)

submitDiscoverObjectClassAttributes

String submitDiscoverObjectClassAttributes(String objectClass,
 Task testTask,
 OperationResult testOperationResult)

submitDiscoverObjectClassEndpoints

String submitDiscoverObjectClassEndpoints(String objectClass,
 Task testTask,
 OperationResult testOperationResult)

submitGenerateArtifact

String submitGenerateArtifact(ConnDevArtifactType artifact,
 boolean retry,
 Task testTask,
 OperationResult testOperationResult)

submitGenerateNativeSchema

default String submitGenerateNativeSchema(String objectClass,
 boolean retry,
 Task task,
 OperationResult result)

submitGenerateConnIdSchema

default String submitGenerateConnIdSchema(String objectClass,
 boolean retry,
 Task testTask,
 OperationResult testOperationResult)

submitGenerateAuthenticationScript

default String submitGenerateAuthenticationScript(boolean retry,
 Task task,
 OperationResult result)

submitGenerateEndpointBasedScript

default String submitGenerateEndpointBasedScript(ConnectorDevelopmentArtifacts.KnownArtifactType artifactDef,
 String objectClass,
 List<ConnDevHttpEndpointType> endpoints,
 boolean retry,
 Task task,
 OperationResult result)

submitGenerateSearchScript

default String submitGenerateSearchScript(String objectClass,
 List<ConnDevHttpEndpointType> endpoints,
 boolean retry,
 Task task,
 OperationResult result)

submitGenerateSearchByIdScript

default String submitGenerateSearchByIdScript(String objectClass,
 List<ConnDevHttpEndpointType> endpoints,
 boolean retry,
 Task task,
 OperationResult result)

submitGenerateSearchFilterScript

default String submitGenerateSearchFilterScript(String objectClass,
 List<ConnDevHttpEndpointType> endpoints,
 boolean retry,
 Task task,
 OperationResult result)

submitGenerateRelationScript

default String submitGenerateRelationScript(ConnDevRelationInfoType relation,
 boolean retry,
 Task task,
 OperationResult result)

submitGenerateCreateScript

default String submitGenerateCreateScript(String objectClass,
 List<ConnDevHttpEndpointType> endpoints,
 boolean retry,
 Task task,
 OperationResult result)

submitGenerateUpdateScript

default String submitGenerateUpdateScript(String objectClass,
 List<ConnDevHttpEndpointType> endpoints,
 boolean retry,
 Task task,
 OperationResult result)

submitGenerateDeleteScript

default String submitGenerateDeleteScript(String objectClass,
 List<ConnDevHttpEndpointType> endpoints,
 boolean retry,
 Task task,
 OperationResult result)

submitGenerateArtifact

String submitGenerateArtifact(ConnDevArtifactType artifact,
 Consumer<ConnDevGenerateArtifactDefinitionType> customizer,
 boolean retry,
 Task task,
 OperationResult result)

testConnection

ResourceType testConnection(ConnectorConfigurationType type)

discoverObjectClasses

StatusInfo<PrismContainer<ConnDevBasicObjectClassInfoType>> discoverObjectClasses()

generateAttributes

StatusInfo<PrismContainer<ConnDevAttributeInfoType>> generateAttributes(ConnDevBasicObjectClassInfoType type)

generateNativeSchemaScript

StatusInfo<ConnDevArtifactType> generateNativeSchemaScript(PrismContainer<ConnDevAttributeInfoType> type)

getArtifactContent

String getArtifactContent(ConnDevArtifactType type,
 Task task,
 OperationResult result)
                   throws IOException

Throws:

IOException

testSchema

BareResourceSchema testSchema(ConnDevArtifactType type)

getSearchEndpoints

StatusInfo<PrismContainer<ConnDevHttpEndpointType>> getSearchEndpoints(String objectClass)

generateSearchAll

StatusInfo<ConnDevArtifactType> generateSearchAll(String objectClass,
 ConnDevHttpEndpointType endpoint)

testSearchAll

void testSearchAll(String objectClass,
 ConnDevArtifactType script)

saveArtifact

void saveArtifact(ConnDevArtifactType endpoint,
 Task task,
 OperationResult result)
           throws IOException,
CommonException

Throws:

IOException

CommonException

saveNativeSchemaScript

default void saveNativeSchemaScript(ConnDevArtifactType artifact,
 Task task,
 OperationResult result)
                             throws IOException,
CommonException

Throws:

IOException

CommonException

saveRelationScript

default void saveRelationScript(ConnDevArtifactType endpoint,
 Task task,
 OperationResult result)
                         throws IOException,
CommonException

Throws:

IOException

CommonException

saveAuthenticationScript

default void saveAuthenticationScript(ConnDevArtifactType artifact,
 Task task,
 OperationResult result)
                               throws IOException,
CommonException

Throws:

IOException

CommonException

saveConnIdSchemaScript

default void saveConnIdSchemaScript(ConnDevArtifactType artifact,
 Task task,
 OperationResult result)
                             throws IOException,
CommonException

Throws:

IOException

CommonException

resetResourceSchema

void resetResourceSchema(Task task,
 OperationResult result)
                  throws SchemaException,
ExpressionEvaluationException,
CommunicationException,
SecurityViolationException,
ConfigurationException,
ObjectNotFoundException,
PolicyViolationException,
ObjectAlreadyExistsException

Throws:

SchemaException

ExpressionEvaluationException

CommunicationException

SecurityViolationException

ConfigurationException

ObjectNotFoundException

PolicyViolationException

ObjectAlreadyExistsException

saveSearchAllScript

default void saveSearchAllScript(ConnDevArtifactType artifact,
 Task task,
 OperationResult result)
                          throws IOException,
CommonException

Throws:

IOException

CommonException

saveGetByIdScript

default void saveGetByIdScript(ConnDevArtifactType artifact,
 Task task,
 OperationResult result)
                        throws IOException,
CommonException

Throws:

IOException

CommonException

saveSearchFilterScript

default void saveSearchFilterScript(ConnDevArtifactType artifact,
 Task task,
 OperationResult result)
                             throws IOException,
CommonException

Throws:

IOException

CommonException

suggestedEndpointsFor

List<ConnDevHttpEndpointType> suggestedEndpointsFor(String objectClass,
 ConnectorDevelopmentArtifacts.KnownArtifactType knownArtifactType)

authenticationSelectionUpdated

void authenticationSelectionUpdated(Task task,
 OperationResult result)
                             throws SchemaException,
ExpressionEvaluationException,
CommunicationException,
SecurityViolationException,
ConfigurationException,
ObjectNotFoundException,
PolicyViolationException,
ObjectAlreadyExistsException

Throws:

SchemaException

ExpressionEvaluationException

CommunicationException

SecurityViolationException

ConfigurationException

ObjectNotFoundException

PolicyViolationException

ObjectAlreadyExistsException

submitRefreshScimSchema

String submitRefreshScimSchema(Task task,
 OperationResult result)