[jbosstools-commits] JBoss Tools SVN: r35207 - trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core.

Author: adietish Date: 2011-09-30 07:19:31 -0400 (Fri, 30 Sep 2011) New Revision: 35207 Modified: trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/ApplicationLogReader.java trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/Cartridge.java trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/IApplication.java trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/IDomain.java trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/IHttpClient.java trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/IOpenshiftService.java trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/InvalidCredentialsOpenshiftException.java trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/OpenshiftEndpointException.java trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/OpenshiftException.java trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/SSHKeyPair.java trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/User.java Log: [JBIDE-9591] corrected class header Modified: trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/ApplicationLogReader.java =================================================================== --- trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/ApplicationLogReader.java 2011-09-30 10:39:42 UTC (rev 35206) +++ trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/ApplicationLogReader.java 2011-09-30 11:19:31 UTC (rev 35207) @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2007 Red Hat, Inc. + * Copyright (c) 2011 Red Hat, Inc. * Distributed under license by Red Hat, Inc. All rights reserved. * This program is made available under the terms of the * Eclipse Public License v1.0 which accompanies this distribution, Modified: trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/Cartridge.java =================================================================== --- trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/Cartridge.java 2011-09-30 10:39:42 UTC (rev 35206) +++ trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/Cartridge.java 2011-09-30 11:19:31 UTC (rev 35207) @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2007 Red Hat, Inc. + * Copyright (c) 2011 Red Hat, Inc. * Distributed under license by Red Hat, Inc. All rights reserved. * This program is made available under the terms of the * Eclipse Public License v1.0 which accompanies this distribution, Modified: trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/IApplication.java =================================================================== --- trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/IApplication.java 2011-09-30 10:39:42 UTC (rev 35206) +++ trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/IApplication.java 2011-09-30 11:19:31 UTC (rev 35207) @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2007 Red Hat, Inc. + * Copyright (c) 2011 Red Hat, Inc. * Distributed under license by Red Hat, Inc. All rights reserved. * This program is made available under the terms of the * Eclipse Public License v1.0 which accompanies this distribution, Modified: trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/IDomain.java =================================================================== --- trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/IDomain.java 2011-09-30 10:39:42 UTC (rev 35206) +++ trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/IDomain.java 2011-09-30 11:19:31 UTC (rev 35207) @@ -1,6 +1,18 @@ +/******************************************************************************* + * Copyright (c) 2011 Red Hat, Inc. + * Distributed under license by Red Hat, Inc. All rights reserved. + * This program is made available under the terms of the + * Eclipse Public License v1.0 which accompanies this distribution, + * and is available at http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Red Hat, Inc. - initial API and implementation + ******************************************************************************/ package org.jboss.ide.eclipse.as.openshift.core; - +/** + * @author André Dietisheim + */ public interface IDomain { public abstract String getNamespace() throws OpenshiftException; Modified: trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/IHttpClient.java =================================================================== --- trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/IHttpClient.java 2011-09-30 10:39:42 UTC (rev 35206) +++ trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/IHttpClient.java 2011-09-30 11:19:31 UTC (rev 35207) @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2007 Red Hat, Inc. + * Copyright (c) 2011 Red Hat, Inc. * Distributed under license by Red Hat, Inc. All rights reserved. * This program is made available under the terms of the * Eclipse Public License v1.0 which accompanies this distribution, Modified: trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/IOpenshiftService.java =================================================================== --- trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/IOpenshiftService.java 2011-09-30 10:39:42 UTC (rev 35206) +++ trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/IOpenshiftService.java 2011-09-30 11:19:31 UTC (rev 35207) @@ -7,7 +7,7 @@ * * Contributors: * Red Hat, Inc. - initial API and implementation - ******************************************************************************/ + ******************************************************************************/ package org.jboss.ide.eclipse.as.openshift.core; import java.util.List; @@ -27,34 +27,62 @@ public static final String BASE_URL = "https://openshift.redhat.com"; /** - * the path (url path addition) + * The path (url path addition) to the service */ public static final String SERVICE_PATH = "/com/broker"; /** - * returns the url at which the service is reachable. + * Returns the url at which the service is reachable. * * @return */ public String getServiceUrl(); - + /** + * Returns the url at which the platform is reachable. + * + * @return + */ + public String getPlatformUrl(); + + /** + * Returns <code>true</code> if the service is reachable. Returns + * <code>false</code> otherwise. + * + * @return true if the service is reachable. + */ + public boolean isReachable(); + + /** + * Returns <code>true</code> if the service is reachable and the credentials + * are valid. Returns <code>false</code> otherwise. + * + * @return + */ + public boolean areCredentialsValid(); + + /** * List all cartridges that are available on the Openshift Express platform. * - * @param user the user account that shall be used + * @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; + public List<ICartridge> getCartridges(InternalUser user) throws OpenshiftException; /** - * Creates an application with the given name and cartridge for the given user. + * 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 + * @param name + * the application name + * @param cartridge + * the cartridge to use + * @param user + * the user account * @return the application that was created * @throws OpenshiftException * @@ -62,14 +90,19 @@ * @see InternalUser * @see IApplication */ - public IApplication 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. + * 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 + * @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 @@ -78,12 +111,16 @@ 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. + * 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 + * @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 * @@ -91,14 +128,19 @@ * @see InternalUser * @see IApplication */ - public IApplication startApplication(String name, ICartridge cartridge, InternalUser user) throws OpenshiftException; - + 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. + * 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 + * @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 * @@ -106,15 +148,20 @@ * @see InternalUser * @see IApplication */ - public IApplication restartApplication(String name, ICartridge cartridge, InternalUser user) throws OpenshiftException; + 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. + * 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 + * @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 * @@ -125,12 +172,16 @@ 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. + * 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 + * @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 * @@ -142,9 +193,12 @@ /** * 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 the user account to use + * @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 * @@ -157,12 +211,16 @@ 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. + * 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 + * @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 * @@ -175,9 +233,10 @@ public IDomain createDomain(String name, ISSHPublicKey sshKey, InternalUser user) throws OpenshiftException; /** - * Returns all informations for the given user and its applications. + * Returns all informations for the given user and its applications. * - * @param user the user account to use + * @param user + * the user account to use * @return all user informations (user related info and applications) * @throws OpenshiftException * Modified: trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/InvalidCredentialsOpenshiftException.java =================================================================== --- trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/InvalidCredentialsOpenshiftException.java 2011-09-30 10:39:42 UTC (rev 35206) +++ trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/InvalidCredentialsOpenshiftException.java 2011-09-30 11:19:31 UTC (rev 35207) @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2007 Red Hat, Inc. + * Copyright (c) 2011 Red Hat, Inc. * Distributed under license by Red Hat, Inc. All rights reserved. * This program is made available under the terms of the * Eclipse Public License v1.0 which accompanies this distribution, Modified: trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/OpenshiftEndpointException.java =================================================================== --- trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/OpenshiftEndpointException.java 2011-09-30 10:39:42 UTC (rev 35206) +++ trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/OpenshiftEndpointException.java 2011-09-30 11:19:31 UTC (rev 35207) @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2007 Red Hat, Inc. + * Copyright (c) 2011 Red Hat, Inc. * Distributed under license by Red Hat, Inc. All rights reserved. * This program is made available under the terms of the * Eclipse Public License v1.0 which accompanies this distribution, Modified: trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/OpenshiftException.java =================================================================== --- trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/OpenshiftException.java 2011-09-30 10:39:42 UTC (rev 35206) +++ trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/OpenshiftException.java 2011-09-30 11:19:31 UTC (rev 35207) @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2007 Red Hat, Inc. + * Copyright (c) 2011 Red Hat, Inc. * Distributed under license by Red Hat, Inc. All rights reserved. * This program is made available under the terms of the * Eclipse Public License v1.0 which accompanies this distribution, Modified: trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/SSHKeyPair.java =================================================================== --- trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/SSHKeyPair.java 2011-09-30 10:39:42 UTC (rev 35206) +++ trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/SSHKeyPair.java 2011-09-30 11:19:31 UTC (rev 35207) @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2007 Red Hat, Inc. + * Copyright (c) 2011 Red Hat, Inc. * Distributed under license by Red Hat, Inc. All rights reserved. * This program is made available under the terms of the * Eclipse Public License v1.0 which accompanies this distribution, Modified: trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/User.java =================================================================== --- trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/User.java 2011-09-30 10:39:42 UTC (rev 35206) +++ trunk/as/plugins/org.jboss.ide.eclipse.as.openshift.core/src/org/jboss/ide/eclipse/as/openshift/core/User.java 2011-09-30 11:19:31 UTC (rev 35207) @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2007 Red Hat, Inc. + * Copyright (c) 2011 Red Hat, Inc. * Distributed under license by Red Hat, Inc. All rights reserved. * This program is made available under the terms of the * Eclipse Public License v1.0 which accompanies this distribution,