public class DynamicAccessModule extends Module implements Access
The Dynamic Access module will associate dynamic disseminators with a digital object. It will look to the Fedora repository configuration file to obtain a list of dynamic disseminators. Currently, the system supports two types of dynamic disseminators: - Default (SDefPID=fedora-system:3 and SDepPID=fedora-system:4) - Bootstrap (SDefPID=fedora-system:1 and SDepPID=fedora-system:2). The Default disseminator that is associated with every object in the repository. The Default Disseminator endows the objects with a set of basic generic behaviors that enable a simplistic view of the object contents (the Item Index) and a list of all disseminations available on the object (the Dissemination Index). The Bootstrap disseminator is associated with every Service Definition and Service Deployment object. It defines methods to get the special metadata datastreams out of them, and some other methods. (NOTE: The Bootstrap Disseminator functionality is NOT YET IMPLEMENTED.
Constants.FedoraHomeACCESS, ACTION, API, ATOM_APIM1_0, ATOM_ZIP1_1, ATOM1_1, AUDIT, AUDIT1_0, BATCH_MODIFY, BATCH_MODIFY1_1, BE_SECURITY, BE_SECURITY1_0, BINDING_SPEC, DATASTREAM, DC, DISSEMINATOR, DS_COMPOSITE_MODEL, DS_COMPOSITE_MODEL1_0, DS_INPUT_SPEC1_0, DS_INPUT_SPEC1_1, ENVIRONMENT, FCFG, FEDORA, FEDORA_APP_CONTEXT_NAME, FEDORA_DEFAULT_APP_CONTEXT, FEDORA_HOME, FEDORA_REPOSITORY_PID, FOXML, FOXML1_0, FOXML1_0_LEGACY, FOXML1_1, HTTP_REQUEST, MANAGEMENT, METHOD_MAP, METS, METS_EXT, METS_EXT1_0, METS_EXT1_0_LEGACY, METS_EXT1_1, MODEL, MULGARA, OAI_DC, OAI_DC2_0, OAI_FRIENDS, OAI_FRIENDS2_0, OAI_IDENTIFIER, OAI_IDENTIFIER2_0, OAI_PMH, OAI_PMH2_0, OAI_PROV, OAI_PROV2_0, OBJ_DATASTREAMS1_0, OBJ_HISTORY1_0, OBJ_ITEMS1_0, OBJ_METHODS1_0, OBJ_PROFILE1_0, OBJ_VALIDATION1_0, OBJECT, OLD_XLINK, PID_LIST1_0, RDF, RDF_XSD, RECOVERY, RELS_EXT, RELS_EXT1_0, RELS_INT1_0, REPO_DESC1_0, RESOURCE, SDEF, SDEF_METHOD_MAP1_0, SDEP, SDEP_METHOD_MAP1_0, SDEP_METHOD_MAP1_1, SERVICE_PROFILE, SOAP, SOAP_ENC, SUBJECT, TYPES, VIEW, WSDL, WSDL_HTTP, WSDL_MIME, XACML_POLICY, XACML_POLICY1_0, XACML1, XACML1_ACTION, XACML1_POLICY, XACML1_RESOURCE, XACML1_SUBJECT, XACML2_POLICY_SCHEMA, XLINK, XML_XSD, XMLNS, XSI| Constructor and Description |
|---|
DynamicAccessModule(Map moduleParameters,
Server server,
String role)
Creates and initializes the Dynmamic Access Module.
|
| Modifier and Type | Method and Description |
|---|---|
RepositoryInfo |
describeRepository(Context context)
Gets information that describes the repository.
|
FieldSearchResult |
findObjects(Context context,
String[] resultFields,
int maxResults,
FieldSearchQuery query)
Lists the specified fields of each object matching the given criteria.
|
MIMETypedStream |
getDatastreamDissemination(Context context,
String PID,
String dsID,
Date asOfDateTime) |
MIMETypedStream |
getDissemination(Context context,
String PID,
String sDefPID,
String methodName,
Property[] userParms,
Date asOfDateTime)
Perform a dissemination for a method that belongs to a dynamic
disseminator that is associate with the digital object.
|
MethodDef[] |
getMethods(Context context,
String PID,
String sDefPID,
Date asOfDateTime)
Get the method defintions for a given dynamic disseminator that
is associated with the digital object.
|
MIMETypedStream |
getMethodsXML(Context context,
String PID,
String sDefPID,
Date asOfDateTime)
Get an XML encoding of the service defintions for a given dynamic
disseminator that is associated with the digital object.
|
String[] |
getObjectHistory(Context context,
String PID)
Gets the change history of an object by returning a list of timestamps
that correspond to modification dates of components.
|
ObjectProfile |
getObjectProfile(Context context,
String PID,
Date asOfDateTime)
Get the profile information for the digital object.
|
String[] |
getServiceDefinitions(Context context,
String PID,
Date asOfDateTime)
Get a list of service definition identifiers for dynamic disseminators
associated with the digital object.
|
protected boolean |
isDynamicService(Context context,
String PID,
String sDefPID) |
DatastreamDef[] |
listDatastreams(Context context,
String PID,
Date asOfDateTime) |
ObjectMethodsDef[] |
listMethods(Context context,
String PID,
Date asOfDateTime)
Get the definitions for all dynamic disseminations on the object.
|
void |
postInitModule()
Second stage of Module initialization.
|
FieldSearchResult |
resumeFindObjects(Context context,
String sessionToken)
Resumes an in-progress listing of object fields.
|
getRole, getServer, initModule, shutdownModulegetHelp, getOptionalParameters, getParameterHelp, getRequiredModuleRoles, getRequiredParametersgetParameter, getParameter, getParameter, getParameterList, getParameters, getParameters, parameterNames, setParameter, setParameters, setParameterspublic DynamicAccessModule(Map moduleParameters, Server server, String role) throws ModuleInitializationException
moduleParameters - A pre-loaded Map of name-value pairs comprising the intended
configuration of this Module.server - The Server instance.role - The role this module fulfills, a java class name.ModuleInitializationException - If initilization values are invalid or initialization fails for
some other reason.public void postInitModule()
throws ModuleInitializationException
ModulepostInitModule in class ModuleModuleInitializationException - If initialization values are invalid or initialization fails for
some other reason.public String[] getServiceDefinitions(Context context, String PID, Date asOfDateTime) throws ServerException
context - PID - identifier of digital object being reflected uponasOfDateTime - ServerExceptionpublic MethodDef[] getMethods(Context context, String PID, String sDefPID, Date asOfDateTime) throws ServerException
context - PID - identifier of digital object being reflected uponsDefPID - identifier of dynamic service definitionasOfDateTime - ServerExceptionpublic MIMETypedStream getMethodsXML(Context context, String PID, String sDefPID, Date asOfDateTime) throws ServerException
context - PID - identifier of digital object being reflected uponsDefPID - identifier of dynamic service definitionasOfDateTime - ServerExceptionpublic MIMETypedStream getDatastreamDissemination(Context context, String PID, String dsID, Date asOfDateTime) throws ServerException
getDatastreamDissemination in interface AccessServerExceptionpublic MIMETypedStream getDissemination(Context context, String PID, String sDefPID, String methodName, Property[] userParms, Date asOfDateTime) throws ServerException
getDissemination in interface Accesscontext - PID - identifier of the digital object being disseminatedsDefPID - identifier of dynamic Service DefinitionmethodName - userParms - asOfDateTime - ServerExceptionpublic ObjectMethodsDef[] listMethods(Context context, String PID, Date asOfDateTime) throws ServerException
This will return the method definitions for all methods for all of the dynamic disseminators associated with the object.
listMethods in interface Accesscontext - PID - identifier of digital object being reflected uponasOfDateTime - ServerExceptionpublic ObjectProfile getObjectProfile(Context context, String PID, Date asOfDateTime) throws ServerException
getObjectProfile in interface Accesscontext - PID - identifier of digital object being reflected uponasOfDateTime - ServerExceptionpublic FieldSearchResult findObjects(Context context, String[] resultFields, int maxResults, FieldSearchQuery query) throws ServerException
AccessfindObjects in interface Accesscontext - the context of this requestresultFields - the names of the fields to returnmaxResults - the maximum number of results to return at a timequery - the queryServerException - If any type of error occurred fulfilling the request.public FieldSearchResult resumeFindObjects(Context context, String sessionToken) throws ServerException
AccessresumeFindObjects in interface Accesscontext - the context of this requestsessionToken - the token of the session in which the remaining results can be
obtainedServerException - If any type of error occurred fulfilling the request.public RepositoryInfo describeRepository(Context context) throws ServerException
AccessdescribeRepository in interface Accesscontext - the context of this requestServerException - If any type of error occurred fulfilling the request.public String[] getObjectHistory(Context context, String PID) throws ServerException
AccessgetObjectHistory in interface Accesscontext - The context of this request.ServerException - If any type of error occurred fulfilling the request.protected boolean isDynamicService(Context context, String PID, String sDefPID) throws ServerException
ServerExceptionpublic DatastreamDef[] listDatastreams(Context context, String PID, Date asOfDateTime) throws ServerException
listDatastreams in interface AccessServerExceptionCopyright © 2013 DuraSpace. All Rights Reserved.