weaver 2004/07/02 07:05:56
Added: portal/src/java/org/apache/jetspeed/deployment
DeploymentObject.java
Log:
Used to be DeploymentHandler
Revision Changes Path
1.1
jakarta-jetspeed-2/portal/src/java/org/apache/jetspeed/deployment/DeploymentObject.java
Index: DeploymentObject.java
===================================================================
/*
* Copyright 2000-2001,2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jetspeed.deployment;
import java.io.IOException;
import java.io.InputStream;
import java.io.Reader;
import org.apache.commons.vfs.FileObject;
/**
* <p>
* DeploymentObject
* </p>
* <p>
* Object representation of a deployment artifact of some type.
* </p>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Scott T. Weaver</a>
* @version $Id: DeploymentObject.java,v 1.1 2004/07/02 14:05:56 weaver Exp $
*
*/
public interface DeploymentObject
{
/**
* Gets the deployment artifacts content as a Stream
* @return
* @throws IOException
*/
InputStream getAsStream() throws IOException;
Reader getAsReader() throws IOException;
/**
* Closes any resources that may have been opend during the use
* of this ObjectHandler.
* @throws IOException
*/
void close() throws IOException;
/**
* retreives the the configuration for this deployment artifact
* based on the artifact-relative <code>configPath</code>
* provided.
* @param configPath artifact-relative path to the confiuration file
* @return Configuration of this artificat or <code>null</code> if the
* configuration is not present in the artifact.
* @throws IOException error opening the configuration
*/
InputStream getConfiguration(String configPath) throws IOException;
/**
*
* <p>
* getName
* </p>
*
* @return name of the deployment object. Yeilds the same result as if you
were
* to invoke: <code>new java.io.File(getPath()).getName()</code>
*/
String getName();
/**
*
* <p>
* getPath
* </p>
*
* @return path the deployment object's source directory or jar/war file.
*/
String getPath();
/**
*
* <p>
* getFileObject
* </p>
*
* @return A <code>org.apache.commons.vfs.FileObject</code> that represents
the file structure of the
* object to deploy. This is usually a LocalFileSystem object or a
JarFileSystem object.
*/
FileObject getFileObject();
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
