[jboss-cvs] JBossAS SVN: r85287 - in projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss: deployers/spi/management/deploy and 2 other directories.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Thu Mar 5 05:22:50 EST 2009
Author: emuckenhuber
Date: 2009-03-05 05:22:49 -0500 (Thu, 05 Mar 2009)
New Revision: 85287
Modified:
projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/ManagementView.java
projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/NameMatcher.java
projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/deploy/DeploymentID.java
projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/deploy/DeploymentManager.java
projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/DeploymentRepository.java
projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/DeploymentRepositoryFactory.java
projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ModificationInfo.java
projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/NoSuchProfileException.java
projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/Profile.java
projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ProfileDeployment.java
projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ProfileKey.java
projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ProfileRepository.java
projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ProfileService.java
projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/metadata/ProfileMetaData.java
projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/metadata/ProfileSourceMetaData.java
Log:
javadoc update
Modified: projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/ManagementView.java
===================================================================
--- projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/ManagementView.java 2009-03-05 08:21:55 UTC (rev 85286)
+++ projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/ManagementView.java 2009-03-05 10:22:49 UTC (rev 85287)
@@ -87,7 +87,7 @@
throws NoSuchDeploymentException, Exception;
/**
- * Get a deployment
+ * Get a deployment.
*
* @param name the name
* @return the deployment
@@ -98,6 +98,7 @@
/**
* Get the deployments of a type.
+ *
* @param type - the deployment or module type.
* @return the possibly empty set of deployment with the given type.
* @throws Exception
@@ -106,7 +107,8 @@
throws Exception;
/**
- * Get the components of a type. The
+ * Get the components of a type.
+ *
* @param type - the component type.
* @return the possibly empty set of components with the given type.
* @throws Exception
@@ -186,7 +188,7 @@
* @throws Exception
*/
void applyTemplate(String deploymentBaseName, DeploymentTemplateInfo info)
- throws Exception;
+ throws Exception;
/**
* Process the changes made to the profile.
Modified: projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/NameMatcher.java
===================================================================
--- projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/NameMatcher.java 2009-03-05 08:21:55 UTC (rev 85286)
+++ projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/NameMatcher.java 2009-03-05 10:22:49 UTC (rev 85287)
@@ -21,7 +21,6 @@
*/
package org.jboss.deployers.spi.management;
-import org.jboss.managed.api.ComponentType;
/**
* An interface for matching a name against a managed element
Modified: projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/deploy/DeploymentID.java
===================================================================
--- projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/deploy/DeploymentID.java 2009-03-05 08:21:55 UTC (rev 85286)
+++ projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/deploy/DeploymentID.java 2009-03-05 10:22:49 UTC (rev 85287)
@@ -35,7 +35,7 @@
public interface DeploymentID
{
/**
- * Get the names of the deployments
+ * Get the names of the deployments.
*
* @return the deployment name
*/
@@ -55,6 +55,7 @@
* from the input name. In this case this method will provide the unique
* names for the input names. Otherwise this returns the same value as
* getNames.
+ *
* @return the unique names of the deployments in the repository
*/
String[] getRepositoryNames();
Modified: projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/deploy/DeploymentManager.java
===================================================================
--- projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/deploy/DeploymentManager.java 2009-03-05 08:21:55 UTC (rev 85286)
+++ projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/deploy/DeploymentManager.java 2009-03-05 10:22:49 UTC (rev 85287)
@@ -24,7 +24,6 @@
import java.net.URL;
import java.util.Collection;
-import org.jboss.profileservice.spi.NoSuchProfileException;
import org.jboss.profileservice.spi.ProfileKey;
/**
@@ -54,9 +53,9 @@
public void releaseProfile() throws Exception;
/**
- * Get a set of profiles supporting deployment actions.
+ * Get a collection of profiles supporting deployment actions.
*
- * @return a set of profiles keys
+ * @return a collection of profiles keys
*/
Collection<ProfileKey> getProfiles();
@@ -102,11 +101,9 @@
/**
* Is redeploy supported.
*
- * @param key the profile key
- * @return true if redeploy suported
- * @throws NoSuchProfileException if there is no such profile
+ * @return true if the loaded profile supports redeploy
*/
- boolean isRedeploySupported(ProfileKey key) throws NoSuchProfileException;
+ boolean isRedeploySupported();
/**
* Do redeploy.
Modified: projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/DeploymentRepository.java
===================================================================
--- projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/DeploymentRepository.java 2009-03-05 08:21:55 UTC (rev 85286)
+++ projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/DeploymentRepository.java 2009-03-05 10:22:49 UTC (rev 85287)
@@ -43,7 +43,7 @@
/**
* Get the uris of this repository.
*
- * @return URI[] the uris of this repository.
+ * @return URI[] the uris of this repository
*/
URI[] getRepositoryURIs();
@@ -74,14 +74,16 @@
void remove() throws Exception;
/**
- * Get the time any contents were last modified
- * @return
+ * Get the time any contents were last modified.
+ *
+ * @return last modified
*/
long getLastModified();
/**
* Get the names of all deployments in the repository
- * @return
+ *
+ * @return the deployment names
*/
Set<String> getDeploymentNames();
@@ -89,7 +91,7 @@
* Get repository names.
*
* @param names the names
- * @return full repository names
+ * @return the matching repository names
* @throws Exception for any error
*/
String[] getRepositoryNames(String... names) throws Exception;
@@ -100,14 +102,14 @@
*
* @param name - the full vfs path of the deployment
* @param contentIS - the input stream for the deployment contents
+ * @return the unique name of the deployment in the repository
* @throws IOException
- * @return the unique name of the deployment in the repository
*/
String addDeploymentContent(String name, InputStream contentIS)
throws IOException;
/**
- * Get the repository virtual file for the given deployment name
+ * Get the repository virtual file for the given deployment name.
*
* @param name - the unique virtual file URI name as returned by addDeploymentContent
* @return the deployment content virtual file
@@ -164,11 +166,10 @@
boolean hasDeploymentContentFlags(String name, int flag);
/**
- * Add a deployment
+ * Add a deployment.
*
- * @param name - the full vfs path of the deployment
+ * @param name - the name of the deployment
* @param deployment the deployment
- * deployment is loaded
* @throws Exception for any error
*/
void addDeployment(String name, ProfileDeployment deployment)
@@ -185,9 +186,9 @@
throws NoSuchDeploymentException;
/**
- * Remove a deployment
+ * Remove a deployment.
*
- * @param name - the full vfs path of the deployment
+ * @param name - the name of the deployment
* @return the removed deployment
* @throws Exception for any error
*/
@@ -196,7 +197,7 @@
/**
* Get all deployments defined in this profile
*
- * @return the deployment instances in this profile.
+ * @return the deployment instances in this profile
*/
Collection<ProfileDeployment> getDeployments();
@@ -205,7 +206,7 @@
*
* @return the modified deployments, empty if there are no
* modifications or hot deployment is not supported.
- * @throws Exception
+ * @throws Exception for any error
*/
Collection<ModificationInfo> getModifiedDeployments() throws Exception;
Modified: projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/DeploymentRepositoryFactory.java
===================================================================
--- projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/DeploymentRepositoryFactory.java 2009-03-05 08:21:55 UTC (rev 85286)
+++ projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/DeploymentRepositoryFactory.java 2009-03-05 10:22:49 UTC (rev 85287)
@@ -36,17 +36,17 @@
/**
* The repository types.
*
- * @return the type.
+ * @return the type
*/
String[] getTypes();
/**
* Create a DeploymentRepository based on a type.
*
- * @param repositoryType the repository type.
- * @param metaData the profile source meta data.
- * @return the deploymentRepository.
- * @throws Exception
+ * @param repositoryType the repository type
+ * @param metaData the profile source meta data
+ * @return the deploymentRepository
+ * @throws Exception for any error
*/
DeploymentRepository createDeploymentRepository(ProfileKey key, ProfileSourceMetaData metaData) throws Exception;
Modified: projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ModificationInfo.java
===================================================================
--- projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ModificationInfo.java 2009-03-05 08:21:55 UTC (rev 85286)
+++ projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ModificationInfo.java 2009-03-05 10:22:49 UTC (rev 85287)
@@ -36,7 +36,7 @@
{
private final static long serialVersionUID = 1;
- public enum ModifyStatus {ADDED, MODIFIED, REMOVED};
+ public enum ModifyStatus { ADDED, MODIFIED, REMOVED };
private ProfileDeployment deployment;
private long lastModified;
Modified: projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/NoSuchProfileException.java
===================================================================
--- projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/NoSuchProfileException.java 2009-03-05 08:21:55 UTC (rev 85286)
+++ projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/NoSuchProfileException.java 2009-03-05 10:22:49 UTC (rev 85287)
@@ -22,7 +22,7 @@
package org.jboss.profileservice.spi;
/**
- * Exception thrown when a profile query failes to find a match.
+ * Exception thrown when a profile query fails to find a match.
*
* @author Scott.Stark at jboss.org
* @version $Revision$
Modified: projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/Profile.java
===================================================================
--- projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/Profile.java 2009-03-05 08:21:55 UTC (rev 85286)
+++ projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/Profile.java 2009-03-05 10:22:49 UTC (rev 85287)
@@ -25,7 +25,7 @@
import java.util.Set;
/**
- * A profile represents a named collection of deployments on a server
+ * A profile represents a named collection of deployments on a server.
*
* @author Scott.Stark at jboss.org
* @author adrian at jboss.org
@@ -54,7 +54,7 @@
Collection<ProfileKey> getSubProfiles();
/**
- * Get the names of the deployments in the profile
+ * Get the names of the deployments in the profile.
* @return names of deployments
*/
Set<String> getDeploymentNames();
@@ -63,8 +63,7 @@
* Get a named deployment.
*
* @param name - the deployment name
- * @return the named bootstrap
- * @throws Exception for any error
+ * @return the deployment
* @throws NoSuchDeploymentException - if there is no such bootstrap
*/
ProfileDeployment getDeployment(String name) throws NoSuchDeploymentException;
@@ -77,7 +76,7 @@
Collection<ProfileDeployment> getDeployments();
/**
- * Checks whether a deployment context is available in the basic profile service.
+ * Checks whether a deployment context is available in this profile.
*
* @param name the name of the deployment
* @return true if the deployment is found or false otherwise
Modified: projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ProfileDeployment.java
===================================================================
--- projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ProfileDeployment.java 2009-03-05 08:21:55 UTC (rev 85286)
+++ projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ProfileDeployment.java 2009-03-05 10:22:49 UTC (rev 85287)
@@ -45,7 +45,7 @@
/**
* Get the root of the deployment
*
- * @return the root, or null if it's not a VFS based deployment
+ * @return the deployment root, null if it's not a VFS based deployment
*/
VirtualFile getRoot();
@@ -57,7 +57,7 @@
Map<String, Object> getAttachments();
/**
- * Get attachment
+ * Get attachment.
*
* @param name the name of the attachment
* @return the attachment or null if not present
Modified: projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ProfileKey.java
===================================================================
--- projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ProfileKey.java 2009-03-05 08:21:55 UTC (rev 85286)
+++ projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ProfileKey.java 2009-03-05 10:22:49 UTC (rev 85287)
@@ -152,11 +152,11 @@
tmp.append(getClass().getSimpleName());
tmp.append('@').append(Integer.toHexString(System.identityHashCode(this)));
tmp.append('[');
- tmp.append("domain=");
+ tmp.append(" domain=");
tmp.append(domain);
- tmp.append(",server=");
+ tmp.append(", server=");
tmp.append(server);
- tmp.append(",name=");
+ tmp.append(", name=");
tmp.append(name);
tmp.append(']');
return tmp.toString();
Modified: projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ProfileRepository.java
===================================================================
--- projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ProfileRepository.java 2009-03-05 08:21:55 UTC (rev 85286)
+++ projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ProfileRepository.java 2009-03-05 10:22:49 UTC (rev 85287)
@@ -27,7 +27,7 @@
import org.jboss.profileservice.spi.metadata.ProfileMetaData;
/**
- * An interface for obtaining DeploymentRepository for a Profile.
+ * An interface for obtaining a DeploymentRepository for a Profile.
*
* @author Scott.Stark at jboss.org
* @author <a href="mailto:emuckenh at redhat.com">Emanuel Muckenhuber</a>
@@ -36,7 +36,8 @@
public interface ProfileRepository
{
/**
- * Get the keys for all known profiles.
+ * Get the keys for all known profiles with a
+ * deploymentRepository.
*
* @return keys for all known profiles.
*/
@@ -48,14 +49,13 @@
* @Param key - the profile key.
* @param metaData - the profile meta data.
* @return the profile DeploymentRepository
- * @throws IOException thrown if the repository cannot be created
* @throws Exception for any error
*/
DeploymentRepository createProfileDeploymentRepository(ProfileKey key, ProfileMetaData metaData)
throws Exception;
/**
- * Get the DeploymentRepository for the given profile key.
+ * Get a created DeploymentRepository for the given profile key.
*
* @param key - the key for the Profile to obtain the DeploymentRepository for.
* @return the profile DeploymentRepository
@@ -68,8 +68,8 @@
* Remove the DeploymentRepository for the given profile key.
*
* @param key - the key for the Profile to obtain the DeploymentRepository for.
+ * @throws NoSuchProfileException thrown if there is no such profile.
* @throws IOException thrown on error removing the repository
- * @throws NoSuchProfileException thrown if there is no such profile.
* @throws Exception for any error
*/
void removeProfileDeploymentRepository(ProfileKey key)
Modified: projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ProfileService.java
===================================================================
--- projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ProfileService.java 2009-03-05 08:21:55 UTC (rev 85286)
+++ projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ProfileService.java 2009-03-05 10:22:49 UTC (rev 85287)
@@ -46,7 +46,7 @@
/**
* Get the keys for all registered profiles.
*
- * @return keys for all registered profiles.
+ * @return keys for all registered profiles
*/
Collection<ProfileKey> getProfileKeys();
@@ -54,7 +54,7 @@
* Obtain the registered profile for the key.
*
* @param key - the key for the profile
- * @return the matching profile.
+ * @return the matching profile
* @throws NoSuchProfileException
*/
Profile getProfile(ProfileKey key) throws NoSuchProfileException;
@@ -62,7 +62,7 @@
/**
* Get the keys for all active profiles.
*
- * @return keys for all active profiles.
+ * @return keys for all active profiles
*/
Collection<ProfileKey> getActiveProfileKeys();
@@ -77,13 +77,13 @@
Profile getActiveProfile(ProfileKey key) throws NoSuchProfileException;
/**
- * Obtain the ManagementView plugin
+ * Obtain the ManagementView plugin.
* @return the ManagementView plugin if supported
*/
ManagementView getViewManager();
/**
- * Obtain the DeploymentManager plugin
+ * Obtain the DeploymentManager plugin.
* @return the DeploymentManager plugin if supported
*/
DeploymentManager getDeploymentManager();
@@ -91,33 +91,33 @@
/**
* Register a Profile.
*
- * @param profile the profile.
- * @throws Exception
+ * @param profile the profile
+ * @throws Exception for any error
*/
void registerProfile(Profile profile) throws Exception;
/**
* Activate a registered profile.
*
- * @param key the profile key.
- * @throws NoSuchProfileException if the profile is not registered.
- * @throws Exception
+ * @param key the profile key
+ * @throws NoSuchProfileException if the profile is not registered
+ * @throws Exception for any error
*/
void activateProfile(ProfileKey key) throws NoSuchProfileException, Exception;
/**
* Deactivate the profile.
*
- * @param key the profile key.
- * @throws NoSuchProfileException if the profile is not active.
+ * @param key the profile key
+ * @throws NoSuchProfileException if the profile is not active
*/
void deactivateProfile(ProfileKey key) throws NoSuchProfileException;
/**
* Unregister a profile.
*
- * @param key the profile key.
- * @throws NoSuchProfileException if the profile is not registered.
+ * @param key the profile key
+ * @throws NoSuchProfileException if the profile is not registered
*/
void unregisterProfile(ProfileKey key) throws NoSuchProfileException;
@@ -125,6 +125,7 @@
* Validate a registered profile.
*
* @param key the profile key
+ * @throws NoSuchProfileException if the profile is not registered
* @throws Exception if the profile is not installed correctly
*/
void validateProfile(ProfileKey key) throws Exception;
Modified: projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/metadata/ProfileMetaData.java
===================================================================
--- projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/metadata/ProfileMetaData.java 2009-03-05 08:21:55 UTC (rev 85286)
+++ projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/metadata/ProfileMetaData.java 2009-03-05 10:22:49 UTC (rev 85287)
@@ -35,7 +35,7 @@
/**
* Get the ProfileSource.
*
- * @return the profile source.
+ * @return the profile source
*/
ProfileSourceMetaData getSource();
Modified: projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/metadata/ProfileSourceMetaData.java
===================================================================
--- projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/metadata/ProfileSourceMetaData.java 2009-03-05 08:21:55 UTC (rev 85286)
+++ projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/metadata/ProfileSourceMetaData.java 2009-03-05 10:22:49 UTC (rev 85287)
@@ -35,14 +35,14 @@
/**
* Get the profile source type.
*
- * @return the type.
+ * @return the type
*/
String getType();
/**
* Get the sources URIs for this source;
*
- * @return the sources/
+ * @return the sources
*/
List<String> getSources();
More information about the jboss-cvs-commits
mailing list