org.dataone.cn.ldap

Class NodeServicesAccess

java.lang.Object

org.dataone.cn.ldap.LDAPService

org.dataone.cn.ldap.NodeServicesAccess

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

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

Author:

waltz

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.logging.Log	log
static String	NODE_SERVICE_AVAILABLE
static String	NODE_SERVICE_ID
static String	NODE_SERVICE_NAME
static String	NODE_SERVICE_VERSION
static String	OBJECT_CLASS_ID

Constructor Summary

Constructors

Constructor and Description
NodeServicesAccess()

Method Summary

Modifier and Type	Method and Description
protected String	buildNodeServiceDN(org.dataone.service.types.v1.NodeReference nodeReference, org.dataone.service.types.v1.Service service) provide a nodeReference and Service to return a string that should conform to distinguished name rules for a node service entry in ldap XXX As an after thought, this should be returning a DN structure not a string!
protected String	buildNodeServiceId(org.dataone.service.types.v1.Service service) the string to identify a service is a combination of the service 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	deleteNodeService(DirContext ctx, org.dataone.service.types.v1.NodeReference nodeReference, org.dataone.service.types.v1.Service service) remove the Node Service 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.v1.Service>	getServiceList(DirContext ctx, String nodeIdentifier) retrieve list of Node Services from LDAP
protected Attributes	mapNodeServiceAttributes(org.dataone.service.types.v2.Node node, org.dataone.service.types.v1.Service service) from the provided Node and Service, fill in the Attributes that will be used to create the Node Service 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_SERVICE_ID

public static final String NODE_SERVICE_ID

See Also:

Constant Field Values

NODE_SERVICE_NAME

public static final String NODE_SERVICE_NAME

See Also:

Constant Field Values

NODE_SERVICE_VERSION

public static final String NODE_SERVICE_VERSION

See Also:

Constant Field Values

NODE_SERVICE_AVAILABLE

public static final String NODE_SERVICE_AVAILABLE

See Also:

Constant Field Values

Constructor Detail

NodeServicesAccess

public NodeServicesAccess()

Method Detail

buildNodeServiceDN

protected String buildNodeServiceDN(org.dataone.service.types.v1.NodeReference nodeReference,
                                    org.dataone.service.types.v1.Service service)

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

Parameters:

nodeReference -

service -

Returns:

String of DN

buildNodeServiceId

protected String buildNodeServiceId(org.dataone.service.types.v1.Service service)

the string to identify a service is a combination of the service 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:

service -

Returns:

String

deleteNodeService

protected Boolean deleteNodeService(DirContext ctx,
                                    org.dataone.service.types.v1.NodeReference nodeReference,
                                    org.dataone.service.types.v1.Service service)

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

Parameters:

nodeReference -

service -

Returns:

Boolean

getServiceList

protected List<org.dataone.service.types.v1.Service> getServiceList(DirContext ctx,
                                                                    String nodeIdentifier)
                                                             throws org.dataone.service.exceptions.ServiceFailure

retrieve list of Node Services from LDAP

Parameters:

nodeIdentifier -

Returns:

List

Throws:

org.dataone.service.exceptions.ServiceFailure

mapNodeServiceAttributes

protected Attributes mapNodeServiceAttributes(org.dataone.service.types.v2.Node node,
                                              org.dataone.service.types.v1.Service service)

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

Parameters:

node -

service -

Returns:

Attributes