org.dataone.cn.ldap

Class NodeAccess

java.lang.Object

org.dataone.cn.ldap.LDAPService

org.dataone.cn.ldap.NodeAccess

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

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

Author:

waltz

Field Summary

Fields

Modifier and Type	Field and Description
static String	AGGREGATE_LOGS
static String	DEFAULT_NON_HARVEST_DATE
static org.apache.commons.logging.Log	log
static String	LOG_LAST_AGGREGATED
static String	NODE_APPROVED
static String	NODE_BASEURL
static String	NODE_CONTACT_SUBJECT
static String	NODE_DESCRIPTION
static String	NODE_ID
static String	NODE_LAST_COMPLETE_HARVEST
static String	NODE_LAST_HARVESTED
static String	NODE_NAME
static String	NODE_REPLICATE
static String	NODE_STATE
static String	NODE_SUBJECT
static String	NODE_SYNCHRONIZE
static String	NODE_TYPE
static String	PING_DATE_CHECKED
static String	PING_SUCCESS
static String	REP_POLICY_ALLOWEDNODE
static String	REP_POLICY_ALLOWEDOBJECTFORMAT
static String	REP_POLICY_MAXOBJECTSIZE
static String	REP_POLICY_SPACEALLOCATED
static String	SYNC_SCHEDULE_HOUR
static String	SYNC_SCHEDULE_MDAY
static String	SYNC_SCHEDULE_MIN
static String	SYNC_SCHEDULE_MON
static String	SYNC_SCHEDULE_SEC
static String	SYNC_SCHEDULE_WDAY
static String	SYNC_SCHEDULE_YEAR

Constructor Summary

Constructors

Constructor and Description
NodeAccess()

Method Summary

Methods

Modifier and Type	Method and Description
protected List<ModificationItem>	calcListModifications(String attributeName, HashMap<String,NamingEnumeration<?>> attributesMap, Collection<String> newValues) create ModificationItems for the named multi-value attribute.
protected List<ModificationItem>	calcModifications(String attributeName, HashMap<String,NamingEnumeration<?>> attributesMap, String newValue) create ModificationItems for the named single-value attribute.
protected List<ModificationItem>	calcSubjectListModifications(String attributeName, HashMap<String,NamingEnumeration<?>> attributesMap, List<org.dataone.service.types.v1.Subject> newValues) create ModificationItems for the named multi-value attribute.
protected void	createNode(DirContext ctx, org.dataone.service.types.v2.Node node) create a DataONE Node
protected Boolean	deleteNode(DirContext ctx, org.dataone.service.types.v1.NodeReference nodeReference) remove the node from LDAP, note all other dependent structures have to be removed before this is called or it will fail.
protected Boolean	getAggregateLogs(DirContext ctx, org.dataone.service.types.v1.NodeReference nodeReference) each MN Node will have a boolean associated with DataONE logAggregation The field is hidden from the nodeList, it may only be manipulated by D1 processing or a DataONE LDAP administrator The LDAP attribute of the Node functionally a replicated lock.
protected org.dataone.service.types.v2.Node	getApprovedNode(DirContext ctx, org.dataone.service.types.v1.NodeReference nodeReference) determine if an Administrator has approved the node after it was registered, Then return the node if it is approved, otherwise throw a NotFound exception
protected List<org.dataone.service.types.v2.Node>	getApprovedNodeList(DirContext ctx) return a list of Nodes that are marked approved in LDAP
protected Date	getDateLastHarvested(DirContext ctx, org.dataone.service.types.v1.NodeReference nodeReference) return the date the last time a node was harvested for log records the date is not the time the harvesting ran, but the latest dateLogged from the LogEvent records harvested
protected Date	getLogLastAggregated(DirContext ctx, org.dataone.service.types.v1.NodeReference nodeReference) return the date the last time a node was harvested for log records the date is not the time the harvesting ran, but the latest dateLogged from the LogEvent records harvested
protected org.dataone.service.types.v2.Node	getNode(DirContext dirContext, org.dataone.service.types.v1.NodeReference nodeReference) retrieve a complete DataONE Node from LDAP.
protected Boolean	getNodeApproved(DirContext ctx, org.dataone.service.types.v1.NodeReference nodeReference) determine if an Administrator has approved the node after it was registered
protected Map<String,String>	getNodeIdList(DirContext ctx) retrieve mapping of all NodeReference values from LDAP to their baseUrls this should contain both approved and non approved ids
protected List<org.dataone.service.types.v1.NodeReference>	getPendingNodeReferenceList(DirContext ctx) get a list of NodeReferences that have yet to be approved by an Administrator after the Nodes have been registered
protected Attributes	mapNodeAttributes(org.dataone.service.types.v2.Node node) from the provided Node instance, fill in the Attributes that will be used to create the Node in LDAP.
protected void	setAggregateLogs(DirContext ctx, org.dataone.service.types.v1.NodeReference nodeIdentifier, Boolean aggregateLogs) update the aggregate Logs Boolean on a DataONE Node
protected void	setDateLastHarvested(DirContext ctx, org.dataone.service.types.v1.NodeReference nodeIdentifier, Date lastDateNodeHarvested) update the date a Member node was last Synchronized Synchronization uses last harvested date to poll membernodes for new content the date is the latest dateSysMetadataModified from the last batch of records harvested
protected void	setLogLastAggregated(DirContext ctx, org.dataone.service.types.v1.NodeReference nodeIdentifier, Date logAggregationDate) update the date a DataONE Node was last Aggregated for Log records LogAggregation uses last aggregated date to poll membernodes for new content the date is the latest dateLogged from the LogEvent records harvested
protected void	setNodeApproved(DirContext ctx, org.dataone.service.types.v1.NodeReference nodeIdentifier, Boolean approved) update a registered DataONE Node to be approved (or unapproved if need be)
protected void	updateNode(DirContext ctx, org.dataone.service.types.v2.Node node) update a DataONE Node

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

DEFAULT_NON_HARVEST_DATE

public static final String DEFAULT_NON_HARVEST_DATE

See Also:

Constant Field Values

NODE_APPROVED

public static final String NODE_APPROVED

See Also:

Constant Field Values

LOG_LAST_AGGREGATED

public static final String LOG_LAST_AGGREGATED

See Also:

Constant Field Values

AGGREGATE_LOGS

public static final String AGGREGATE_LOGS

See Also:

Constant Field Values

NODE_ID

public static final String NODE_ID

See Also:

Constant Field Values

NODE_NAME

public static final String NODE_NAME

See Also:

Constant Field Values

NODE_DESCRIPTION

public static final String NODE_DESCRIPTION

See Also:

Constant Field Values

NODE_BASEURL

public static final String NODE_BASEURL

See Also:

Constant Field Values

SYNC_SCHEDULE_SEC

public static final String SYNC_SCHEDULE_SEC

See Also:

Constant Field Values

SYNC_SCHEDULE_MIN

public static final String SYNC_SCHEDULE_MIN

See Also:

Constant Field Values

SYNC_SCHEDULE_HOUR

public static final String SYNC_SCHEDULE_HOUR

See Also:

Constant Field Values

SYNC_SCHEDULE_MDAY

public static final String SYNC_SCHEDULE_MDAY

See Also:

Constant Field Values

SYNC_SCHEDULE_MON

public static final String SYNC_SCHEDULE_MON

See Also:

Constant Field Values

SYNC_SCHEDULE_WDAY

public static final String SYNC_SCHEDULE_WDAY

See Also:

Constant Field Values

SYNC_SCHEDULE_YEAR

public static final String SYNC_SCHEDULE_YEAR

See Also:

Constant Field Values

NODE_LAST_HARVESTED

public static final String NODE_LAST_HARVESTED

See Also:

Constant Field Values

NODE_LAST_COMPLETE_HARVEST

public static final String NODE_LAST_COMPLETE_HARVEST

See Also:

Constant Field Values

REP_POLICY_MAXOBJECTSIZE

public static final String REP_POLICY_MAXOBJECTSIZE

See Also:

Constant Field Values

REP_POLICY_SPACEALLOCATED

public static final String REP_POLICY_SPACEALLOCATED

See Also:

Constant Field Values

REP_POLICY_ALLOWEDNODE

public static final String REP_POLICY_ALLOWEDNODE

See Also:

Constant Field Values

REP_POLICY_ALLOWEDOBJECTFORMAT

public static final String REP_POLICY_ALLOWEDOBJECTFORMAT

See Also:

Constant Field Values

PING_SUCCESS

public static final String PING_SUCCESS

See Also:

Constant Field Values

PING_DATE_CHECKED

public static final String PING_DATE_CHECKED

See Also:

Constant Field Values

NODE_SUBJECT

public static final String NODE_SUBJECT

See Also:

Constant Field Values

NODE_CONTACT_SUBJECT

public static final String NODE_CONTACT_SUBJECT

See Also:

Constant Field Values

NODE_REPLICATE

public static final String NODE_REPLICATE

See Also:

Constant Field Values

NODE_SYNCHRONIZE

public static final String NODE_SYNCHRONIZE

See Also:

Constant Field Values

NODE_TYPE

public static final String NODE_TYPE

See Also:

Constant Field Values

NODE_STATE

public static final String NODE_STATE

See Also:

Constant Field Values

Constructor Detail

NodeAccess

public NodeAccess()

Method Detail

deleteNode

protected Boolean deleteNode(DirContext ctx,
                 org.dataone.service.types.v1.NodeReference nodeReference)
                      throws org.dataone.service.exceptions.ServiceFailure

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

Parameters:

nodeReference -

Returns:

Boolean

Throws:

org.dataone.service.exceptions.ServiceFailure

getApprovedNodeList

protected List<org.dataone.service.types.v2.Node> getApprovedNodeList(DirContext ctx)
                                                               throws org.dataone.service.exceptions.ServiceFailure

return a list of Nodes that are marked approved in LDAP

Returns:

List

Throws:

org.dataone.service.exceptions.ServiceFailure

getDateLastHarvested

protected Date getDateLastHarvested(DirContext ctx,
                        org.dataone.service.types.v1.NodeReference nodeReference)
                             throws org.dataone.service.exceptions.ServiceFailure

return the date the last time a node was harvested for log records the date is not the time the harvesting ran, but the latest dateLogged from the LogEvent records harvested

Parameters:

nodeReference -

Returns:

Date

Throws:

org.dataone.service.exceptions.ServiceFailure

getLogLastAggregated

protected Date getLogLastAggregated(DirContext ctx,
                        org.dataone.service.types.v1.NodeReference nodeReference)
                             throws org.dataone.service.exceptions.ServiceFailure

return the date the last time a node was harvested for log records the date is not the time the harvesting ran, but the latest dateLogged from the LogEvent records harvested

Parameters:

nodeReference -

Returns:

Date

Throws:

org.dataone.service.exceptions.ServiceFailure

getNode

protected org.dataone.service.types.v2.Node getNode(DirContext dirContext,
                                        org.dataone.service.types.v1.NodeReference nodeReference)
                                             throws org.dataone.service.exceptions.NotFound,
                                                    NamingException,
                                                    NameNotFoundException

retrieve a complete DataONE Node from LDAP.

Parameters:

nodeDN - Distinguished name of the DN, provided by buildNodeDN

Returns:

Node

Throws:

NamingException

org.dataone.service.exceptions.NotFound

NameNotFoundException

getApprovedNode

protected org.dataone.service.types.v2.Node getApprovedNode(DirContext ctx,
                                                org.dataone.service.types.v1.NodeReference nodeReference)
                                                     throws org.dataone.service.exceptions.ServiceFailure,
                                                            org.dataone.service.exceptions.NotFound

determine if an Administrator has approved the node after it was registered, Then return the node if it is approved, otherwise throw a NotFound exception

Parameters:

nodeIdentifier -

Returns:

Boolean

Throws:

org.dataone.service.exceptions.ServiceFailure

org.dataone.service.exceptions.NotFound

getNodeApproved

protected Boolean getNodeApproved(DirContext ctx,
                      org.dataone.service.types.v1.NodeReference nodeReference)
                           throws org.dataone.service.exceptions.ServiceFailure

determine if an Administrator has approved the node after it was registered

Parameters:

nodeIdentifier -

Returns:

Boolean

Throws:

org.dataone.service.exceptions.ServiceFailure

getNodeIdList

protected Map<String,String> getNodeIdList(DirContext ctx)
                                    throws org.dataone.service.exceptions.ServiceFailure

retrieve mapping of all NodeReference values from LDAP to their baseUrls this should contain both approved and non approved ids

Returns:

Map

Throws:

org.dataone.service.exceptions.ServiceFailure

getPendingNodeReferenceList

protected List<org.dataone.service.types.v1.NodeReference> getPendingNodeReferenceList(DirContext ctx)
                                                                                throws org.dataone.service.exceptions.ServiceFailure

get a list of NodeReferences that have yet to be approved by an Administrator after the Nodes have been registered

Returns:

List

Throws:

org.dataone.service.exceptions.ServiceFailure

getAggregateLogs

protected Boolean getAggregateLogs(DirContext ctx,
                       org.dataone.service.types.v1.NodeReference nodeReference)
                            throws org.dataone.service.exceptions.ServiceFailure

each MN Node will have a boolean associated with DataONE logAggregation The field is hidden from the nodeList, it may only be manipulated by D1 processing or a DataONE LDAP administrator The LDAP attribute of the Node functionally a replicated lock. It works in conjuction with a java distributed lock to ensure that only a single log aggregation process at a time may be running. The attribute may also serve as a backend mechanism to turn logAggregation off for a particular node

Parameters:

nodeIdentifier -

Returns:

AggregateLogs

Throws:

org.dataone.service.exceptions.ServiceFailure

mapNodeAttributes

protected Attributes mapNodeAttributes(org.dataone.service.types.v2.Node node)

from the provided Node instance, fill in the Attributes that will be used to create the Node in LDAP. This is a lower-level mapping responsible only for a subset of the attribute mappings. So, note that NodeServices and ServiceMethodRestrictions are not included in this mapping.

Parameters:

node -

Returns:

Attributes

setDateLastHarvested

protected void setDateLastHarvested(DirContext ctx,
                        org.dataone.service.types.v1.NodeReference nodeIdentifier,
                        Date lastDateNodeHarvested)
                             throws org.dataone.service.exceptions.ServiceFailure

update the date a Member node was last Synchronized Synchronization uses last harvested date to poll membernodes for new content the date is the latest dateSysMetadataModified from the last batch of records harvested

Parameters:

nodeIdentifier -

lastDateNodeHarvested -

Throws:

org.dataone.service.exceptions.ServiceFailure

setLogLastAggregated

protected void setLogLastAggregated(DirContext ctx,
                        org.dataone.service.types.v1.NodeReference nodeIdentifier,
                        Date logAggregationDate)
                             throws org.dataone.service.exceptions.ServiceFailure

update the date a DataONE Node was last Aggregated for Log records LogAggregation uses last aggregated date to poll membernodes for new content the date is the latest dateLogged from the LogEvent records harvested

Parameters:

nodeIdentifier -

logAggregationDate -

Throws:

org.dataone.service.exceptions.ServiceFailure

setNodeApproved

protected void setNodeApproved(DirContext ctx,
                   org.dataone.service.types.v1.NodeReference nodeIdentifier,
                   Boolean approved)
                        throws org.dataone.service.exceptions.ServiceFailure

update a registered DataONE Node to be approved (or unapproved if need be)

Parameters:

nodeIdentifier -

approved -

Throws:

org.dataone.service.exceptions.ServiceFailure

createNode

protected void createNode(DirContext ctx,
              org.dataone.service.types.v2.Node node)
                   throws org.dataone.service.exceptions.NotImplemented,
                          org.dataone.service.exceptions.ServiceFailure,
                          org.dataone.service.exceptions.InvalidRequest,
                          org.dataone.service.exceptions.NotFound

create a DataONE Node

Parameters:

node -

Throws:

org.dataone.service.exceptions.ServiceFailure

org.dataone.service.exceptions.NotImplemented

org.dataone.service.exceptions.InvalidRequest

org.dataone.service.exceptions.NotFound

updateNode

protected void updateNode(DirContext ctx,
              org.dataone.service.types.v2.Node node)
                   throws org.dataone.service.exceptions.NotImplemented,
                          org.dataone.service.exceptions.ServiceFailure,
                          org.dataone.service.exceptions.InvalidRequest,
                          org.dataone.service.exceptions.NotFound

update a DataONE Node

Parameters:

node -

Throws:

org.dataone.service.exceptions.ServiceFailure

org.dataone.service.exceptions.NotImplemented

org.dataone.service.exceptions.InvalidRequest

org.dataone.service.exceptions.NotFound

setAggregateLogs

protected void setAggregateLogs(DirContext ctx,
                    org.dataone.service.types.v1.NodeReference nodeIdentifier,
                    Boolean aggregateLogs)
                         throws org.dataone.service.exceptions.ServiceFailure

update the aggregate Logs Boolean on a DataONE Node

Parameters:

nodeIdentifier -

aggregateLogs -

Throws:

org.dataone.service.exceptions.ServiceFailure

calcModifications

protected List<ModificationItem> calcModifications(String attributeName,
                                       HashMap<String,NamingEnumeration<?>> attributesMap,
                                       String newValue)
                                            throws NamingException

create ModificationItems for the named single-value attribute. There will be zero or 1 modification item, depending on whether a change is required. A null newValue parameter will be treated as empty String, and will result in removal of the existing value.

Throws:

NamingException

calcListModifications

protected List<ModificationItem> calcListModifications(String attributeName,
                                           HashMap<String,NamingEnumeration<?>> attributesMap,
                                           Collection<String> newValues)
                                                throws NamingException

create ModificationItems for the named multi-value attribute. There will be [0..2] modification items, depending on whether additions, removals, or both are needed. A null newValues parameter will be treated as empty list, and will result in removal of existing value. of existing values)

Type Parameters:

E -

Parameters:

attributesMap -

newValues -

attributeName -

Returns:

Throws:

NamingException

calcSubjectListModifications

protected List<ModificationItem> calcSubjectListModifications(String attributeName,
                                                  HashMap<String,NamingEnumeration<?>> attributesMap,
                                                  List<org.dataone.service.types.v1.Subject> newValues)
                                                       throws NamingException

create ModificationItems for the named multi-value attribute. There will be [0..2] modification items, depending on whether additions, removals, or both are needed. A null newValues parameter will be treated as empty list, and will result in removal of existing value. of existing values)

Parameters:

attributesMap -

newValues -

attributeName -

Returns:

Throws:

NamingException