Package com.exclamationlabs.connid.base.connector.attribute

Class ConnectorAttributeMapBuilder<C extends Enum<C>>

java.lang.Object

com.exclamationlabs.connid.base.connector.attribute.ConnectorAttributeMapBuilder<C>

Type Parameters:

C - Your own enum type needs to be supplied here that gives the names of attributes (for a group or for a user)

public class ConnectorAttributeMapBuilder<C extends Enum<C>>
extends Object

Builder to aid with the definition of connector attributes. Attributes are needed by Midpoint to setup the schema and lay out all the data elements available for Users and Groups in a connector.

Field Summary

Fields

Modifier and Type	Field	Description
protected EnumMap<C,ConnectorAttribute>	map

Constructor Summary

Constructors

Constructor	Description
ConnectorAttributeMapBuilder(Class<C> enumClass)	You must create the builder with your own enum class that gives attribute names (for a group or for a user)

Method Summary

Modifier and Type	Method	Description
ConnectorAttributeMapBuilder<C>	add(C enumClass, ConnectorAttributeDataType dataType, org.identityconnectors.framework.common.objects.AttributeInfo.Flags... flags)	Method to append another attribute definition to the builder.
EnumMap<?,ConnectorAttribute>	build()	When you are all done calling add() methods for all attribute, call build() to produce the EnumMap that will hold the attribute types (for a user or for a group).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

map

protected EnumMap<C extends Enum<C>,ConnectorAttribute> map

Constructor Details

ConnectorAttributeMapBuilder

public ConnectorAttributeMapBuilder(Class<C> enumClass)

You must create the builder with your own enum class that gives attribute names (for a group or for a user)

Parameters:

enumClass - Class object for your custom enum with attribute names

Method Details

add

public ConnectorAttributeMapBuilder<C> add(C enumClass, ConnectorAttributeDataType dataType, org.identityconnectors.framework.common.objects.AttributeInfo.Flags... flags)

Method to append another attribute definition to the builder.

Parameters:

enumClass - Enum value representing a connector attribute name

dataType - Acceptable data type for ConnId.

flags - Optional. Any number of flags restricting or describing ConnId usage for this attribute. Possible flags are ... REQUIRED, MULTIVALUED, NOT_CREATABLE, NOT_UPDATEABLE, NOT_READABLE, NOT_RETURNED_BY_DEFAULT

Returns:

builder object in progress

build

public EnumMap<?,ConnectorAttribute> build()

When you are all done calling add() methods for all attribute, call build() to produce the EnumMap that will hold the attribute types (for a user or for a group).

Returns:

EnumMap containing all attribute definitions (for a user or for a group)