com.cloudbees.plugins.deployer.records

Class DeployedApplicationLocation

java.lang.Object

com.cloudbees.plugins.deployer.records.DeployedApplicationLocation

All Implemented Interfaces:

Serializable

public abstract class DeployedApplicationLocation
extends Object
implements Serializable

Represents information about an application that has been deployed to an URL.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DeployedApplicationLocation(String locationURL) Constructs a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
abstract String	getDescription() Returns the description of the deployment, e.g.
abstract String	getDisplayName() Returns the display name of the hosting service.
abstract String	getImageOf(String size) Returns the URL to the image.
String	getLocationURL() Returns the URL that the application can be accessed at.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeployedApplicationLocation

protected DeployedApplicationLocation(@NonNull
                                      String locationURL)

Constructs a new instance.

Parameters:

locationURL - the URL that the application can be accessed at.

Method Detail

getLocationURL

@NonNull
public String getLocationURL()

Returns the URL that the application can be accessed at.

Returns:

the URL that the application can be accessed at.

getImageOf

@CheckForNull
public abstract String getImageOf(@CheckForNull
                                                String size)

Returns the URL to the image.

Parameters:

size - The size specified. Must support "16x16", "24x24", and "32x32" at least. For forward compatibility, if you receive a size that's not supported, consider returning your biggest icon (and let the browser rescale.)

Returns:

The URL is rendered as is in the img @src attribute, so it must contain the context path, etc.

getDisplayName

@CheckForNull
public abstract String getDisplayName()

Returns the display name of the hosting service.

Returns:

the display name of the hosting service.

getDescription

@CheckForNull
public abstract String getDescription()

Returns the description of the deployment, e.g. deployment parameters etc.

Returns:

the description of the deployment, e.g. deployment parameters etc.

equals

@OverrideMustInvoke(value=ANYTIME)
public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

@OverrideMustInvoke(value=ANYTIME)
public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object