Author: adietish Date: 2011-09-28 14:33:13 -0400 (Wed, 28 Sep 2011) New Revision: 35128 Modified: trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/internal/IOpenshiftService.java trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/internal/InternalUser.java Log: [JBIDE-9591] added javadoc, cleaned API Modified: trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/internal/IOpenshiftService.java =================================================================== --- trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/internal/IOpenshiftService.java 2011-09-28 18:27:42 UTC (rev 35127) +++ trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/internal/IOpenshiftService.java 2011-09-28 18:33:13 UTC (rev 35128) @@ -47,8 +47,9 @@ * * @see ICartridge * @see InternalUser + * @see IApplication */ - public Application createApplication(String name, ICartridge cartridge, InternalUser user) throws OpenshiftException; + public IApplication createApplication(String name, ICartridge cartridge, InternalUser user) throws OpenshiftException; /** * Destroys the application with the given name and cartridge for the given user. @@ -75,6 +76,7 @@ * * @see ICartridge * @see InternalUser + * @see IApplication */ public IApplication startApplication(String name, ICartridge cartridge, InternalUser user) throws OpenshiftException; @@ -89,6 +91,7 @@ * * @see ICartridge * @see InternalUser + * @see IApplication */ public IApplication restartApplication(String name, ICartridge cartridge, InternalUser user) throws OpenshiftException; @@ -104,6 +107,7 @@ * * @see ICartridge * @see InternalUser + * @see IApplication */ public IApplication stopApplication(String name, ICartridge cartridge, InternalUser user) throws OpenshiftException; @@ -127,18 +131,46 @@ * * @param name the new domain name(-space) * @param sshKey the ssh key that shall be used. - * @param user - * @return + * @param user the user account to use + * @return the domain that was changed * @throws OpenshiftException * * @see ICartridge * @see InternalUser * @see SSHKeyPair * @see ISSHPublicKey + * @see IDomain */ public IDomain changeDomain(String name, ISSHPublicKey sshKey, InternalUser user) throws OpenshiftException; + /** + * Creates a domain (namespace) with the given name for the given user account with the given ssh public key. + * If a domain already exists an OpenshiftEndpointException is thrown. + * + * @param name the new domain name(-space) + * @param sshKey the ssh key that shall be used. + * @param user the user account to use + * @return the domain that was changed + * @throws OpenshiftException + * + * @see ICartridge + * @see InternalUser + * @see SSHKeyPair + * @see ISSHPublicKey + * @see IDomain + */ public IDomain createDomain(String name, ISSHPublicKey sshKey, InternalUser user) throws OpenshiftException; + /** + * Returns all informations for the given user and its applications. + * + * @param user the user account to use + * @return all user informations (user related info and applications) + * @throws OpenshiftException + * + * @see InternalUser + * @see UserInfo + * @see ApplicationInfo + */ public UserInfo getUserInfo(InternalUser user) throws OpenshiftException; } Modified: trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/internal/InternalUser.java =================================================================== --- trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/internal/InternalUser.java 2011-09-28 18:27:42 UTC (rev 35127) +++ trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/internal/InternalUser.java 2011-09-28 18:33:13 UTC (rev 35128) @@ -106,7 +106,7 @@ @Override public IApplication createApplication(String name, ICartridge cartridge) throws OpenshiftException { - Application application = service.createApplication(name, cartridge, this); + IApplication application = service.createApplication(name, cartridge, this); add(application); return application; } @@ -134,7 +134,7 @@ return matchingApplication; } - public void add(Application application) { + public void add(IApplication application) { applications.add(application); }