org.rhq.core.pluginapi.inventory
Class CreateResourceReport

java.lang.Object
  org.rhq.core.pluginapi.inventory.CreateResourceReport

public class CreateResourceReport
extends Object

Value object used between the plugin container and a plugin to carry all data necessary for a create resource operation as well as the resulting status code.

Author:

Jason Dobies

Constructor Summary

CreateResourceReport(String userSpecifiedResourceName, ResourceType resourceType, Configuration pluginConfiguration, Configuration resourceConfiguration, ResourcePackageDetails packageDetails)
Creates a report with immutable information the plugin should not be able to change.

Method Summary

String	getErrorMessage()
Throwable	getException()
ResourcePackageDetails	getPackageDetails()
Configuration	getPluginConfiguration()
Configuration	getResourceConfiguration()
String	getResourceKey()
String	getResourceName()
ResourceType	getResourceType()
CreateResourceStatus	getStatus()
String	getUserSpecifiedResourceName()
void	setErrorMessage(String errorMessage)
void	setException(Throwable exception)
void	setResourceKey(String resourceKey)
void	setResourceName(String resourceName)
void	setStatus(CreateResourceStatus status)
void	setUserSpecifiedResourceName(String userSpecifiedResourceName)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateResourceReport

public CreateResourceReport(String userSpecifiedResourceName,
                            ResourceType resourceType,
                            Configuration pluginConfiguration,
                            Configuration resourceConfiguration,
                            ResourcePackageDetails packageDetails)

Creates a report with immutable information the plugin should not be able to change. The plugin will add the necessary details to this report to indicate the result of the creation.

Parameters:

userSpecifiedResourceName - resource name the user gave to the resource at creation time; may be null

resourceType - type of resource being created

pluginConfiguration - user specified plugin configuration to connect to the resource; may be null

resourceConfiguration - any configuration values necessary for the resource; may be null

packageDetails - information regarding the package to be deployed when creating the new resource; may be null

Method Detail

getUserSpecifiedResourceName

public String getUserSpecifiedResourceName()

setUserSpecifiedResourceName

public void setUserSpecifiedResourceName(String userSpecifiedResourceName)

setResourceName

public void setResourceName(String resourceName)

setResourceKey

public void setResourceKey(String resourceKey)

setErrorMessage

public void setErrorMessage(String errorMessage)

setStatus

public void setStatus(CreateResourceStatus status)

setException

public void setException(Throwable exception)

getResourceType

public ResourceType getResourceType()

getPluginConfiguration

public Configuration getPluginConfiguration()

getResourceConfiguration

public Configuration getResourceConfiguration()

getPackageDetails

public ResourcePackageDetails getPackageDetails()

getResourceName

public String getResourceName()

getResourceKey

public String getResourceKey()

getStatus

public CreateResourceStatus getStatus()

getErrorMessage

public String getErrorMessage()

getException

public Throwable getException()

toString

public String toString()

Overrides:

toString in class Object