Interface CreateApiOp
-
- All Superinterfaces:
APIOperation
- All Known Subinterfaces:
ConnectorFacade
- All Known Implementing Classes:
AbstractConnectorFacade
,CreateImpl
,LocalConnectorFacadeImpl
,RemoteConnectorFacadeImpl
public interface CreateApiOp extends APIOperation
-
-
Field Summary
-
Fields inherited from interface org.identityconnectors.framework.api.operations.APIOperation
NO_TIMEOUT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Uid
create(ObjectClass objectClass, Set<Attribute> createAttributes, OperationOptions options)
Create a target object based on the specified attributes.
-
-
-
Method Detail
-
create
Uid create(ObjectClass objectClass, Set<Attribute> createAttributes, OperationOptions options)
Create a target object based on the specified attributes. The Connector framework always requires attributeObjectClass
. TheConnector
itself may require additional attributes. The API will confirm that the set contains theObjectClass
attribute and that no two attributes in the set have the samename
.- Parameters:
objectClass
- the type of object to create. Must not be null.createAttributes
- includes all the attributes necessary to create the target object (including theObjectClass
attribute).options
- additional options that impact the way this operation is run. May be null.- Returns:
- the unique id for the object that is created. For instance in LDAP this would be the 'dn', for a database this would be the primary key, and for 'ActiveDirectory' this would be the GUID.
- Throws:
IllegalArgumentException
- ifObjectClass
is missing or elements of the set produce duplicate values ofAttribute.getName()
.NullPointerException
- if the parametercreateAttributes
isnull
.RuntimeException
- if theConnector
SPI throws a nativeException
.
-
-