Author: adietish Date: 2011-09-28 14:27:42 -0400 (Wed, 28 Sep 2011) New Revision: 35127 Modified: trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/internal/IOpenshiftService.java trunk/as/tests/org.jboss.ide.eclipse.as.openshift.test/src/org/jboss/ide/eclipse/as/openshift/test/internal/core/ApplicationTest.java trunk/as/tests/org.jboss.ide.eclipse.as.openshift.test/src/org/jboss/ide/eclipse/as/openshift/test/internal/core/CartridgesIntegrationTest.java trunk/as/tests/org.jboss.ide.eclipse.as.openshift.test/src/org/jboss/ide/eclipse/as/openshift/test/internal/core/UserIntegrationTest.java trunk/as/tests/org.jboss.ide.eclipse.as.openshift.test/src/org/jboss/ide/eclipse/as/openshift/test/internal/core/UserTest.java trunk/as/tests/org.jboss.ide.eclipse.as.openshift.test/src/org/jboss/ide/eclipse/as/openshift/test/internal/core/utils/ApplicationUtils.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 17:13:54 UTC (rev 35126) +++ 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) @@ -25,20 +25,117 @@ public static final String BASE_URL = "https://openshift.redhat.com/broker"; + /** + * List all cartridges that are available on the Openshift Express platform. + * + * @param user the user account that shall be used + * @return the list of cartridges available on the platform + * @throws OpenshiftException + * + * @see InternalUser + */ public List<ICartridge> getCartridges(InternalUser user) throws OpenshiftException; + /** + * Creates an application with the given name and cartridge for the given user. + * + * @param name the application name + * @param cartridge the cartridge to use + * @param user the user account + * @return the application that was created + * @throws OpenshiftException + * + * @see ICartridge + * @see InternalUser + */ public Application createApplication(String name, ICartridge cartridge, InternalUser user) throws OpenshiftException; + /** + * Destroys the application with the given name and cartridge for the given user. + * + * @param name the name of the application that shall be destroyed + * @param cartridge the cartridge that the application is running on + * @param user the user account + * @throws OpenshiftException + * + * @see ICartridge + * @see InternalUser + */ public void destroyApplication(String name, ICartridge cartridge, InternalUser user) throws OpenshiftException; + /** + * Starts the application with the given name and cartridge for the given user account. + * Starting an application that is already started has no effect. + * + * @param name of the application that shall be started + * @param cartridge the cartridge the application is running on + * @param user the user account to use + * @return the application that was started + * @throws OpenshiftException + * + * @see ICartridge + * @see InternalUser + */ public IApplication startApplication(String name, ICartridge cartridge, InternalUser user) throws OpenshiftException; + /** + * Restarts the application with the given name and cartridge for the given user account. + * + * @param name the name of the application that shall be restarted + * @param cartridge the cartridge the application is running on + * @param user the user account to use + * @return the application that was started + * @throws OpenshiftException + * + * @see ICartridge + * @see InternalUser + */ public IApplication restartApplication(String name, ICartridge cartridge, InternalUser user) throws OpenshiftException; + /** + * Stops the application with the given name and cartridge for the given user account. Stopping an application + * that is already stopped has no effect. + * + * @param name the name of the application that shall be restarted + * @param cartridge the cartridge the application is running on + * @param user the user account to use + * @return the application that was stopped + * @throws OpenshiftException + * + * @see ICartridge + * @see InternalUser + */ public IApplication stopApplication(String name, ICartridge cartridge, InternalUser user) throws OpenshiftException; + /** + * Returns the log of the application with the given name and cartridge. Returns the whole log if + * no new log entry was created since the last call. Returns the new entries otherwise. + * + * @param name of the application that the log shall be returned of + * @param cartridge the cartridge the application is running on + * @param user the user account to use + * @return the log of the application + * @throws OpenshiftException + * + * @see ICartridge + * @see InternalUser + */ public String getStatus(String name, ICartridge cartridge, InternalUser user) throws OpenshiftException; + /** + * Changes the current domain (namespace) to the given name. + * + * @param name the new domain name(-space) + * @param sshKey the ssh key that shall be used. + * @param user + * @return + * @throws OpenshiftException + * + * @see ICartridge + * @see InternalUser + * @see SSHKeyPair + * @see ISSHPublicKey + */ public IDomain changeDomain(String name, ISSHPublicKey sshKey, InternalUser user) throws OpenshiftException; public IDomain createDomain(String name, ISSHPublicKey sshKey, InternalUser user) throws OpenshiftException; Modified: trunk/as/tests/org.jboss.ide.eclipse.as.openshift.test/src/org/jboss/ide/eclipse/as/openshift/test/internal/core/ApplicationTest.java =================================================================== --- trunk/as/tests/org.jboss.ide.eclipse.as.openshift.test/src/org/jboss/ide/eclipse/as/openshift/test/internal/core/ApplicationTest.java 2011-09-28 17:13:54 UTC (rev 35126) +++ trunk/as/tests/org.jboss.ide.eclipse.as.openshift.test/src/org/jboss/ide/eclipse/as/openshift/test/internal/core/ApplicationTest.java 2011-09-28 18:27:42 UTC (rev 35127) @@ -26,8 +26,8 @@ import org.jboss.ide.eclipse.as.openshift.core.OpenshiftException; import org.jboss.ide.eclipse.as.openshift.core.internal.Application; import org.jboss.ide.eclipse.as.openshift.core.internal.ApplicationInfo; +import org.jboss.ide.eclipse.as.openshift.core.internal.InternalUser; import org.jboss.ide.eclipse.as.openshift.core.internal.OpenshiftService; -import org.jboss.ide.eclipse.as.openshift.core.internal.InternalUser; import org.jboss.ide.eclipse.as.openshift.core.internal.UserInfo; import org.jboss.ide.eclipse.as.openshift.core.internal.request.ApplicationAction; import org.jboss.ide.eclipse.as.openshift.core.internal.request.ApplicationRequest; Modified: trunk/as/tests/org.jboss.ide.eclipse.as.openshift.test/src/org/jboss/ide/eclipse/as/openshift/test/internal/core/CartridgesIntegrationTest.java =================================================================== --- trunk/as/tests/org.jboss.ide.eclipse.as.openshift.test/src/org/jboss/ide/eclipse/as/openshift/test/internal/core/CartridgesIntegrationTest.java 2011-09-28 17:13:54 UTC (rev 35126) +++ trunk/as/tests/org.jboss.ide.eclipse.as.openshift.test/src/org/jboss/ide/eclipse/as/openshift/test/internal/core/CartridgesIntegrationTest.java 2011-09-28 18:27:42 UTC (rev 35127) @@ -16,8 +16,8 @@ import java.util.List; import org.jboss.ide.eclipse.as.openshift.core.ICartridge; +import org.jboss.ide.eclipse.as.openshift.core.User; import org.jboss.ide.eclipse.as.openshift.core.internal.OpenshiftService; -import org.jboss.ide.eclipse.as.openshift.core.internal.InternalUser; import org.jboss.ide.eclipse.as.openshift.test.internal.core.fakes.TestUser; import org.junit.Before; import org.junit.Ignore; @@ -30,7 +30,7 @@ private OpenshiftService openshiftService; - private InternalUser user; + private User user; @Before public void setUp() { Modified: trunk/as/tests/org.jboss.ide.eclipse.as.openshift.test/src/org/jboss/ide/eclipse/as/openshift/test/internal/core/UserIntegrationTest.java =================================================================== --- trunk/as/tests/org.jboss.ide.eclipse.as.openshift.test/src/org/jboss/ide/eclipse/as/openshift/test/internal/core/UserIntegrationTest.java 2011-09-28 17:13:54 UTC (rev 35126) +++ trunk/as/tests/org.jboss.ide.eclipse.as.openshift.test/src/org/jboss/ide/eclipse/as/openshift/test/internal/core/UserIntegrationTest.java 2011-09-28 18:27:42 UTC (rev 35127) @@ -25,7 +25,7 @@ import org.jboss.ide.eclipse.as.openshift.core.ISSHPublicKey; import org.jboss.ide.eclipse.as.openshift.core.OpenshiftEndpointException; import org.jboss.ide.eclipse.as.openshift.core.OpenshiftException; -import org.jboss.ide.eclipse.as.openshift.core.internal.InternalUser; +import org.jboss.ide.eclipse.as.openshift.core.User; import org.jboss.ide.eclipse.as.openshift.core.internal.OpenshiftService; import org.jboss.ide.eclipse.as.openshift.test.internal.core.fakes.TestUser; import org.jboss.ide.eclipse.as.openshift.test.internal.core.utils.ApplicationUtils; @@ -37,7 +37,7 @@ */ public class UserIntegrationTest { - private InternalUser user; + private User user; @Before public void setUp() throws OpenshiftException, DatatypeConfigurationException { Modified: trunk/as/tests/org.jboss.ide.eclipse.as.openshift.test/src/org/jboss/ide/eclipse/as/openshift/test/internal/core/UserTest.java =================================================================== --- trunk/as/tests/org.jboss.ide.eclipse.as.openshift.test/src/org/jboss/ide/eclipse/as/openshift/test/internal/core/UserTest.java 2011-09-28 17:13:54 UTC (rev 35126) +++ trunk/as/tests/org.jboss.ide.eclipse.as.openshift.test/src/org/jboss/ide/eclipse/as/openshift/test/internal/core/UserTest.java 2011-09-28 18:27:42 UTC (rev 35127) @@ -29,8 +29,8 @@ import org.jboss.ide.eclipse.as.openshift.core.ISSHPublicKey; import org.jboss.ide.eclipse.as.openshift.core.OpenshiftException; import org.jboss.ide.eclipse.as.openshift.core.internal.ApplicationInfo; +import org.jboss.ide.eclipse.as.openshift.core.internal.InternalUser; import org.jboss.ide.eclipse.as.openshift.core.internal.OpenshiftService; -import org.jboss.ide.eclipse.as.openshift.core.internal.InternalUser; import org.jboss.ide.eclipse.as.openshift.core.internal.UserInfo; import org.jboss.ide.eclipse.as.openshift.core.internal.utils.RFC822DateUtils; import org.jboss.ide.eclipse.as.openshift.test.internal.core.fakes.CartridgeResponseFake; Modified: trunk/as/tests/org.jboss.ide.eclipse.as.openshift.test/src/org/jboss/ide/eclipse/as/openshift/test/internal/core/utils/ApplicationUtils.java =================================================================== --- trunk/as/tests/org.jboss.ide.eclipse.as.openshift.test/src/org/jboss/ide/eclipse/as/openshift/test/internal/core/utils/ApplicationUtils.java 2011-09-28 17:13:54 UTC (rev 35126) +++ trunk/as/tests/org.jboss.ide.eclipse.as.openshift.test/src/org/jboss/ide/eclipse/as/openshift/test/internal/core/utils/ApplicationUtils.java 2011-09-28 18:27:42 UTC (rev 35127) @@ -13,9 +13,9 @@ import org.jboss.ide.eclipse.as.openshift.core.Cartridge; import org.jboss.ide.eclipse.as.openshift.core.ICartridge; import org.jboss.ide.eclipse.as.openshift.core.OpenshiftException; +import org.jboss.ide.eclipse.as.openshift.core.User; import org.jboss.ide.eclipse.as.openshift.core.internal.Application; import org.jboss.ide.eclipse.as.openshift.core.internal.IOpenshiftService; -import org.jboss.ide.eclipse.as.openshift.core.internal.InternalUser; /** * @author André Dietisheim @@ -26,11 +26,11 @@ return String.valueOf(System.currentTimeMillis()); } - public static Application createApplication(InternalUser user, IOpenshiftService service) throws OpenshiftException { + public static Application createApplication(User user, IOpenshiftService service) throws OpenshiftException { return service.createApplication(createRandomApplicationName(), Cartridge.JBOSSAS_7, user); } - public static void silentlyDestroyAS7Application(String name, InternalUser user, IOpenshiftService service) { + public static void silentlyDestroyAS7Application(String name, User user, IOpenshiftService service) { try { service.destroyApplication(name, ICartridge.JBOSSAS_7, user); } catch (OpenshiftException e) {