DirectoryServer.java
/*
** Module : DirectoryServer.java
** Abstract : exports the primary directory API via the network protocol and
** provides the backing service for that API
**
** Copyright (c) 2008-2024, Golden Code Development Corporation.
**
** -#- -I- --Date-- --JPRM-- ---------------------------Description----------------------------
** 001 GES 20080409 @37909 Created initial version which has a simple
** getter API only.
** 002 HC 20180813 Added double data type to the directory access interface.
** 003 EVL 20190430 Added other search modes.
** GES 20190509 Reworked to use the same approach in all APIs. Made common code.
** 004 HC 20200130 Added a method for enumerating nodes.
** 005 GBB 20240709 Added method getBoolean for wrapper class Boolean.
*/
/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
**
** Additional terms under GNU Affero GPL version 3 section 7:
**
** Under Section 7 of the GNU Affero GPL version 3, the following additional
** terms apply to the works covered under the License. These additional terms
** are non-permissive additional terms allowed under Section 7 of the GNU
** Affero GPL version 3 and may not be removed by you.
**
** 0. Attribution Requirement.
**
** You must preserve all legal notices or author attributions in the covered
** work or Appropriate Legal Notices displayed by works containing the covered
** work. You may not remove from the covered work any author or developer
** credit already included within the covered work.
**
** 1. No License To Use Trademarks.
**
** This license does not grant any license or rights to use the trademarks
** Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
** of Golden Code Development Corporation. You are not authorized to use the
** name Golden Code, FWD, or the names of any author or contributor, for
** publicity purposes without written authorization.
**
** 2. No Misrepresentation of Affiliation.
**
** You may not represent yourself as Golden Code Development Corporation or FWD.
**
** You may not represent yourself for publicity purposes as associated with
** Golden Code Development Corporation, FWD, or any author or contributor to
** the covered work, without written authorization.
**
** 3. No Misrepresentation of Source or Origin.
**
** You may not represent the covered work as solely your work. All modified
** versions of the covered work must be marked in a reasonable way to make it
** clear that the modified work is not originating from Golden Code Development
** Corporation or FWD. All modified versions must contain the notices of
** attribution required in this license.
*/
package com.goldencode.p2j.directory;
import com.goldencode.p2j.util.*;
import java.util.*;
/**
* Provides a network accessible server for the primary API for directory
* access.
*/
public class DirectoryServer
implements Directory
{
/**
* Access a data value from the directory as specified by the given
* absolute or relative node ID.
*
* @param search
* Must be one of <code>ID_ABSOLUTE</code> (if the given node
* ID includes all paths from the root of the directory tree to
* the node being read) or <code>ID_RELATIVE</code> if the given
* ID is only a relative portion which should be found via a
* search through a standard set of search paths.
* @param id
* The node ID to retrieve.
* @param initial
* The initial value to return if a node of the proper type is
* not found by the given node ID or if no node is found by the
* given node ID.
*
* @return The data value at that node ID or the default initial value.
*/
public String getString(int search, String id, String initial)
{
// TODO: add support for ID_ABSOLUTE
return Utils.getDirectoryNodeString(null, id, initial, searchType(search), null);
}
/**
* {@inheritDoc}
*/
@Override
public List<String> getStrings(int search, String id)
{
return Utils.getDirectoryNodeStrings(null, id, searchType(search), null);
}
/**
* Access a data value from the directory as specified by the given
* absolute or relative node ID.
*
* @param search
* Must be one of <code>ID_ABSOLUTE</code> (if the given node
* ID includes all paths from the root of the directory tree to
* the node being read) or <code>ID_RELATIVE</code> if the given
* ID is only a relative portion which should be found via a
* search through a standard set of search paths.
* @param id
* The node ID to retrieve.
* @param initial
* The initial value to return if a node of the proper type is
* not found by the given node ID or if no node is found by the
* given node ID.
*
* @return The data value at that node ID or the default initial value.
*/
public char getChar(int search, String id, char initial)
{
// TODO: add support for ID_ABSOLUTE
return Utils.getDirectoryNodeChar(null, id, initial, searchType(search), null);
}
/**
* Access a data value from the directory as specified by the given
* absolute or relative node ID.
*
* @param search
* Must be one of <code>ID_ABSOLUTE</code> (if the given node
* ID includes all paths from the root of the directory tree to
* the node being read) or <code>ID_RELATIVE</code> if the given
* ID is only a relative portion which should be found via a
* search through a standard set of search paths.
* @param id
* The node ID to retrieve.
* @param initial
* The initial value to return if a node of the proper type is
* not found by the given node ID or if no node is found by the
* given node ID.
*
* @return The data value at that node ID or the default initial value.
*/
public int getInt(int search, String id, int initial)
{
// TODO: add support for ID_ABSOLUTE
return Utils.getDirectoryNodeInt(null, id, initial, searchType(search), null);
}
/**
* Access a data value from the directory as specified by the given
* absolute or relative node ID.
*
* @param search
* Must be one of <code>ID_ABSOLUTE</code> (if the given node
* ID includes all paths from the root of the directory tree to
* the node being read) or <code>ID_RELATIVE</code> if the given
* ID is only a relative portion which should be found via a
* search through a standard set of search paths.
* @param id
* The node ID to retrieve.
* @param initial
* The initial value to return if a node of the proper type is
* not found by the given node ID or if no node is found by the
* given node ID.
*
* @return The data value at that node ID or the default initial value.
*/
public double getDouble(int search, String id, double initial)
{
// TODO: add support for ID_ABSOLUTE
return Utils.getDirectoryNodeDouble(null, id, initial, searchType(search), null);
}
/**
* Access a data value from the directory as specified by the given
* absolute or relative node ID.
*
* @param search
* Must be one of <code>ID_ABSOLUTE</code> (if the given node
* ID includes all paths from the root of the directory tree to
* the node being read) or <code>ID_RELATIVE</code> if the given
* ID is only a relative portion which should be found via a
* search through a standard set of search paths.
* @param id
* The node ID to retrieve.
* @param initial
* The initial value to return if a node of the proper type is
* not found by the given node ID or if no node is found by the
* given node ID.
*
* @return The data value at that node ID or the default initial value.
*/
public boolean getBoolean(int search, String id, boolean initial)
{
// TODO: add support for ID_ABSOLUTE
return Utils.getDirectoryNodeBoolean(null, id, initial, searchType(search), null);
}
/**
* Access a data value from the directory as specified by the given
* absolute or relative node ID.
*
* @param search
* Must be one of <code>ID_ABSOLUTE</code> (if the given node
* ID includes all paths from the root of the directory tree to
* the node being read) or <code>ID_RELATIVE</code> if the given
* ID is only a relative portion which should be found via a
* search through a standard set of search paths.
* @param id
* The node ID to retrieve.
* @param initial
* The initial value to return if a node of the proper type is
* not found by the given node ID or if no node is found by the
* given node ID.
*
* @return The data value at that node ID or the default initial value.
*/
public Boolean getBoolean(int search, String id, Boolean initial)
{
// TODO: add support for ID_ABSOLUTE
return Utils.getDirectoryNodeBoolean(null, id, initial, searchType(search), null);
}
/**
* {@inheritDoc}
*/
@Override
public List<String> enumerateNodes(int search, String id)
{
// TODO: add support for ID_ABSOLUTE
return Utils.enumerateNodes(null, id, searchType(search), null);
}
/**
* Translate the integer search criteria into the version needed by the directory helpers.
*
* @param search
* {@link Directory#ID_ABSOLUTE}, {@link Directory#ID_RELATIVE},
* {@link Directory#ID_RELATIVE_ACCOUNT} or {@link Directory#ID_RELATIVE_SERVER}.
*
* @return A valid enum for the helper code.
*/
private Utils.DirScope searchType(int search)
{
Utils.DirScope type = Utils.DirScope.ACCOUNTS;
switch (search)
{
case ID_RELATIVE_BOTH:
{
type = Utils.DirScope.BOTH;
break;
}
case ID_RELATIVE_SERVER:
{
type = Utils.DirScope.SERVER;
break;
}
}
return type;
}
}