DPML Notify

[mcconnell AT dpml.net]

Author: mcconnell AT dpml.net
Date: Fri Mar 25 13:06:45 2005
New Revision: 2132

Added:
   
development/main/metro/context/api/src/main/net/dpml/context/ComponentContext.java
Log:
Add the ComponentContext interface.

Added: 
development/main/metro/context/api/src/main/net/dpml/context/ComponentContext.java
==============================================================================
--- (empty file)
+++ 
development/main/metro/context/api/src/main/net/dpml/context/ComponentContext.java
  Fri Mar 25 13:06:45 2005
@@ -0,0 +1,65 @@
+/*
+ * Copyright 2005 Stephen J. McConnell.
+ * 
+ * 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 net.dpml.context;
+
+import java.io.File;
+
+/**
+ * <p>
+ * The context is the interface through which resources are provided by 
+ * a container to a component.
+ * </p>
+ * 
+ *
+ * @author <a href="mailto:dev-dpml AT lists.ibiblio.org";>The Digital Product 
Meta Library</a>
+ * @version $Id: Context.java 259 2004-10-30 07:24:40Z mcconnell $
+ */
+public interface ComponentContext
+{
+    /**
+     * Get the working directory asigned to the component.  An implementation
+     * is required to return a unique directory per component. The file that
+     * is returned does not necesarly need to exist. The working directory
+     * shall be the same across multiple sessions.
+     * 
+     * @return the the working directory
+     */
+    File getWorkingDirectory();
+
+    /**
+     * Get the temporary directory asigned to the component.  An 
implementation
+     * is required to return a unique directory per component. The file that
+     * is returned does not necesarly need to exist.
+     * 
+     * @return the temporary directory
+     */
+    File getTempDirectory();
+
+    /**
+     * Return the name of the component.
+     * 
+     * @return the component name
+     */
+    String getName();
+
+    /**
+     * Return the partition assigned to the component.
+     * 
+     * @return the assigned partition
+     */
+    String getPartition();
+
+}