org.dataone.cn.ldap

Class NodePropertyAccess

java.lang.Object

org.dataone.cn.ldap.LDAPService

org.dataone.cn.ldap.NodePropertyAccess

public class NodePropertyAccess
extends org.dataone.cn.ldap.LDAPService

Provides Access to retrieve, remove and modify the LDAP Node Property Data Structure

Author:

waltz

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.logging.Log	log
static String	NODE_PROPERTY_ID
static String	NODE_PROPERTY_KEY
static String	NODE_PROPERTY_TYPE
static String	NODE_PROPERTY_VALUE
static String	OBJECT_CLASS_ID

Constructor Summary

Constructors

Constructor and Description
NodePropertyAccess()

Method Summary

Modifier and Type	Method and Description
protected String	buildNodePropertyDN(org.dataone.service.types.v1.NodeReference nodeReference, org.dataone.service.types.v2.Property property) provide a nodeReference and Property to return a string that should conform to distinguished name rules for a node property entry in ldap XXX As an after thought, this should be returning a DN structure not a string!
protected String	buildNodePropertyId(org.dataone.service.types.v2.Property property) the string to identify a property is a combination of the property name and its version in order to differentiate it from other versions of the same name The function will return a string such that name-version is the result
protected Boolean	deleteNodeProperty(DirContext ctx, org.dataone.service.types.v1.NodeReference nodeReference, org.dataone.service.types.v2.Property property) remove the Node Property from LDAP, note all other dependent structures have to be removed before this is called or it will fail.
protected List<org.dataone.service.types.v2.Property>	getPropertyList(DirContext ctx, String nodeIdentifier) retrieve list of Node Properties from LDAP
protected Attributes	mapNodePropertyAttributes(org.dataone.service.types.v2.Node node, org.dataone.service.types.v2.Property property) from the provided Node and Service, fill in the Attributes that will be used to create the Node Property entry in LDAP ServiceMethodRestrictions are not included in this mapping

Methods inherited from class org.dataone.cn.ldap.LDAPService

addCountry, addDc, addOrg, addOrgUnit, checkAttribute, constructTree, getAttributeValues, getBase, getEnumerationValueString, parseAttribute, removeEntry, setBase

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.commons.logging.Log log

OBJECT_CLASS_ID

public static final String OBJECT_CLASS_ID

See Also:

Constant Field Values

NODE_PROPERTY_ID

public static final String NODE_PROPERTY_ID

See Also:

Constant Field Values

NODE_PROPERTY_KEY

public static final String NODE_PROPERTY_KEY

See Also:

Constant Field Values

NODE_PROPERTY_VALUE

public static final String NODE_PROPERTY_VALUE

See Also:

Constant Field Values

NODE_PROPERTY_TYPE

public static final String NODE_PROPERTY_TYPE

See Also:

Constant Field Values

Constructor Detail

NodePropertyAccess

public NodePropertyAccess()

Method Detail

buildNodePropertyDN

protected String buildNodePropertyDN(org.dataone.service.types.v1.NodeReference nodeReference,
                                     org.dataone.service.types.v2.Property property)

provide a nodeReference and Property to return a string that should conform to distinguished name rules for a node property entry in ldap XXX As an after thought, this should be returning a DN structure not a string!

Parameters:

nodeReference -

property -

Returns:

String of DN

buildNodePropertyId

protected String buildNodePropertyId(org.dataone.service.types.v2.Property property)

the string to identify a property is a combination of the property name and its version in order to differentiate it from other versions of the same name The function will return a string such that name-version is the result

Parameters:

property -

Returns:

String

deleteNodeProperty

protected Boolean deleteNodeProperty(DirContext ctx,
                                     org.dataone.service.types.v1.NodeReference nodeReference,
                                     org.dataone.service.types.v2.Property property)

remove the Node Property from LDAP, note all other dependent structures have to be removed before this is called or it will fail.

Parameters:

nodeReference -

property -

Returns:

Boolean

getPropertyList

protected List<org.dataone.service.types.v2.Property> getPropertyList(DirContext ctx,
                                                                      String nodeIdentifier)
                                                               throws org.dataone.service.exceptions.ServiceFailure

retrieve list of Node Properties from LDAP

Parameters:

nodeIdentifier -

Returns:

List

Throws:

org.dataone.service.exceptions.ServiceFailure

mapNodePropertyAttributes

protected Attributes mapNodePropertyAttributes(org.dataone.service.types.v2.Node node,
                                               org.dataone.service.types.v2.Property property)

from the provided Node and Service, fill in the Attributes that will be used to create the Node Property entry in LDAP ServiceMethodRestrictions are not included in this mapping

Parameters:

node -

property -

Returns:

Attributes