Skip navigation links
org.identityconnectors.framework.spi.operations
Interface CreateOp
- All Superinterfaces:
- SPIOperation
-
public interface CreateOp
- extends SPIOperation
The Connector
developer is responsible for taking the attributes given (which always includes the ObjectClass
) and create an object and its Uid
. The Connector
developer must return the Uid
so that the caller can refer to the created object.
The Connector
developer should make a best effort to create the object otherwise throw an informative RuntimeException
telling the caller why the operation could not be completed. It reasonable to use defaults for required Attribute
s as long as they are documented.
- Since:
- 1.0
- Version:
- $Revision $
- Author:
- Will Droste
create
Uid create(ObjectClass oclass,
java.util.Set<Attribute> attrs,
OperationOptions options)
- The
Connector
developer is responsible for taking the attributes given (which always includes the ObjectClass
) and create an object and its Uid
. The Connector
developer must return the Uid
so that the caller can refer to the created object.
*Note: There will never be a Uid
passed in with the attribute set for this method. If the resource supports some sort of mutable Uid
, you should create your own resource-specific attribute for it, such as unix_uid.
-
- Parameters:
attrs
- includes all the attributes necessary to create the resource object including the ObjectClass
attribute and Name
attribute.
options
- additional options that impact the way this operation is run. If the caller passes null, the framework will convert this into an empty set of options, so SPI need not worry about this ever being 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.
Skip navigation links
Copyright © 2012, Oracle and/or its affiliates. All rights reserved.