fedora.server.storage
Class DefaultExternalContentManager

java.lang.Object
  fedora.server.Parameterized
      fedora.server.Pluggable
          fedora.server.Module
              fedora.server.storage.DefaultExternalContentManager

All Implemented Interfaces:

ExternalContentManager, Logging

public class DefaultExternalContentManager

extends Module

implements ExternalContentManager

Title: DefaultExternalContentManager.java

Description: Provides a mechanism to obtain external HTTP-accessible content.

-----------------------------------------------------------------------------

License and Copyright: The contents of this file are subject to the Mozilla Public License Version 1.1 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.mozilla.org/MPL/.

Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License.

The entire file consists of original code. Copyright © 2002-2005 by The Rector and Visitors of the University of Virginia and Cornell University. All rights reserved.

-----------------------------------------------------------------------------

Version:

$Id: DefaultExternalContentManager.java,v 1.19 2005/01/11 20:06:07 cwilper Exp $

Author:

rlw@virginia.edu

Constructor Summary

DefaultExternalContentManager(java.util.Map moduleParameters, Server server, java.lang.String role)
Creates a new DefaultExternalContentManager.

Method Summary

MIMETypedStream	getExternalContent(java.lang.String URL) A method that reads the contents of the specified URL and returns the result as a MIMETypedStream
void	initModule() Initializes the Module based on configuration parameters.

Methods inherited from class fedora.server.Module

getRole, getServer, logConfig, logFine, logFiner, logFinest, loggingConfig, loggingFine, loggingFiner, loggingFinest, loggingInfo, loggingSevere, loggingWarning, logInfo, logSevere, logWarning, postInitModule, shutdownModule

Methods inherited from class fedora.server.Pluggable

getHelp, getOptionalParameters, getParameterHelp, getRequiredModuleRoles, getRequiredParameters

Methods inherited from class fedora.server.Parameterized

getParameter, getParameters, parameterNames, setParameter, setParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultExternalContentManager

public DefaultExternalContentManager(java.util.Map moduleParameters,
                                     Server server,
                                     java.lang.String role)
                              throws ModuleInitializationException

Creates a new DefaultExternalContentManager.

Parameters:

moduleParameters - The name/value pair map of module parameters.

server - The server instance.

role - The module role name.

Throws:

ModuleInitializationException - If initialization values are invalid or initialization fails for some other reason.

Method Detail

initModule

public void initModule()
                throws ModuleInitializationException

Initializes the Module based on configuration parameters. The implementation of this method is dependent on the schema used to define the parameter names for the role of fedora.server.storage.DefaultExternalContentManager.

Overrides:

initModule in class Module

Throws:

ModuleInitializationException - If initialization values are invalid or initialization fails for some other reason.

getExternalContent

public MIMETypedStream getExternalContent(java.lang.String URL)
                                   throws GeneralException,
                                          HttpServiceNotFoundException

A method that reads the contents of the specified URL and returns the result as a MIMETypedStream

Specified by:

getExternalContent in interface ExternalContentManager

Parameters:

URL - The URL of the external content.

Returns:

A MIME-typed stream.

Throws:

HttpServiceNotFoundException - If the URL connection could not be established.

GeneralException