openconnector

Class Schema

java.lang.Object

openconnector.Schema

public class Schema
extends java.lang.Object

A Schema describes the attributes that are supported in a resource object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Schema.Attribute The definition of a resource object attribute.
static class	Schema.Type An enumeration of attribute types.

Constructor Summary

Constructors

Constructor and Description
Schema() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(Schema.Attribute attr) Add one attribute definition to the schema.
void	addAttribute(java.lang.String name)
void	addAttribute(java.lang.String name, Schema.Type type)
void	addAttribute(java.lang.String name, Schema.Type type, boolean multi)
void	addAttribute(java.lang.String name, Schema.Type type, java.lang.Integer size)
void	addAttribute(java.lang.String name, Schema.Type type, java.lang.Integer size, boolean multi)
java.util.List<java.lang.String>	getAttributeNames()
java.util.List<Schema.Attribute>	getAttributes()
java.lang.String	getGroupAttribute() Determine which attribute in an account schema represents the "group" attribute.
java.lang.String	getIdentityAttribute()
boolean	getIncludePermissions()
java.lang.String	getNativeObjectType()
java.lang.String	getObjectType()
void	setAttributes(java.util.List<Schema.Attribute> attributes) Set the list of attributes defined in this schema.
void	setIdentityAttribute(java.lang.String name) Set the name of the attribute from the attributes list that represents the object identity or "naming" attribute.
void	setIncludePermissions(boolean includePermissions) Set the IncludePermissions attribute of schema.
void	setNativeObjectType(java.lang.String name) Set the name of the native application object.
void	setObjectType(java.lang.String type) Set the type of object this schema describes.

Methods inherited from class java.lang.Object

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

Constructor Detail

Schema

public Schema()

Constructor.

Method Detail

getObjectType

public java.lang.String getObjectType()

Returns:

the type of object this schema describes. This will be one of the OBJECT_TYPE constants from Connector.

setObjectType

public void setObjectType(java.lang.String type)

Set the type of object this schema describes. This will be one of the OBJECT_TYPE constants from Connector.

getIdentityAttribute

public java.lang.String getIdentityAttribute()

Returns:

the name of the attribute from the attributes list that represents the object identity or "naming" attribute.

setIdentityAttribute

public void setIdentityAttribute(java.lang.String name)

Set the name of the attribute from the attributes list that represents the object identity or "naming" attribute.

getNativeObjectType

public java.lang.String getNativeObjectType()

Returns:

the name of native application object.

setNativeObjectType

public void setNativeObjectType(java.lang.String name)

Set the name of the native application object.

getAttributes

public java.util.List<Schema.Attribute> getAttributes()

Returns:

the list of attributes defined in this schema.

setAttributes

public void setAttributes(java.util.List<Schema.Attribute> attributes)

Set the list of attributes defined in this schema.

getAttributeNames

public java.util.List<java.lang.String> getAttributeNames()

Returns:

a list of the attribute names defined for this schema.

getIncludePermissions

public boolean getIncludePermissions()

Returns:

the IncludePermissions attribute from schema.

setIncludePermissions

public void setIncludePermissions(boolean includePermissions)

Set the IncludePermissions attribute of schema.

getGroupAttribute

public java.lang.String getGroupAttribute()

Determine which attribute in an account schema represents the "group" attribute. This is modeled with an Attribute having its objectType set to a value that matches one of the Schemas. Currently we only have one for groups, but in theory this can extend to allow references to objects of other complex types.

addAttribute

public void addAttribute(Schema.Attribute attr)

Add one attribute definition to the schema.

addAttribute

public void addAttribute(java.lang.String name)

addAttribute

public void addAttribute(java.lang.String name,
                         Schema.Type type)

addAttribute

public void addAttribute(java.lang.String name,
                         Schema.Type type,
                         boolean multi)

addAttribute

public void addAttribute(java.lang.String name,
                         Schema.Type type,
                         java.lang.Integer size)

addAttribute

public void addAttribute(java.lang.String name,
                         Schema.Type type,
                         java.lang.Integer size,
                         boolean multi)