Update attribute values operation
Connectors continue to be released outside the IDM release. For the latest documentation, refer to the ICF documentation. |
The update attribute values operation is an advanced implementation of the update operation. You should implement this operation if you want your connector to offer better performance and atomicity for the following methods:
-
UpdateApiOp.addAttributeValues(ObjectClass, Uid, Set, OperationOptions)
-
UpdateApiOp.removeAttributeValues(ObjectClass, Uid, Set, OperationOptions)
Consumption of the Add and Remove Attribute Values Methods at the API Level
@Test
public void addAttributeValuesTest() {
logger.info("Running AddAttributeValues Test");
final ConnectorFacade facade = createConnectorFacade(BasicConnector.class, null);
final OperationOptionsBuilder builder = new OperationOptionsBuilder();
Set<Attribute> updateAttributes = new HashSet<Attribute>();
// add 'group2' to existing groups
updateAttributes.add(AttributeBuilder.build(PredefinedAttributes.GROUPS_NAME, "group2"));
Uid uid =
facade.addAttributeValues(ObjectClass.ACCOUNT, new Uid("Foo"), updateAttributes,
builder.build());
Assert.assertEquals(uid.getUidValue(), "foo");
}
@Test
public void removeAttributeValuesTest() {
logger.info("Running RemoveAttributeValues Test");
final ConnectorFacade facade = createConnectorFacade(BasicConnector.class, null);
final OperationOptionsBuilder builder = new OperationOptionsBuilder();
Set<Attribute> updateAttributes = new HashSet<Attribute>();
// remove 'group2' from existing groups
updateAttributes.add(AttributeBuilder.build(PredefinedAttributes.GROUPS_NAME, "group2"));
Uid uid =
facade.removeAttributeValues(ObjectClass.ACCOUNT, new Uid("Foo"), updateAttributes,
builder.build());
Assert.assertEquals(uid.getUidValue(), "foo");
}
Implement the update attribute values operation
At the SPI level, the update attribute values operation returns an UnknownUidException
when the UID does not exist on the resource.
Implementation of the update attribute values operation, at the SPILevel
public Uid addAttributeValues(ObjectClass objectClass, Uid uid, Set<Attribute> valuesToAdd,
OperationOptions options) {
return uid;
}
public Uid removeAttributeValues(ObjectClass objectClass, Uid uid,
Set<Attribute> valuesToRemove, OperationOptions options) {
return uid;
}