public class Blueprint extends Object implements oracle.fmwplatform.envspec.common.Versioned
Constructor and Description |
---|
Blueprint() |
Modifier and Type | Method and Description |
---|---|
boolean |
addAllExternalServices(List<String> externalServices)
Adds a list of ResourceGroupTarget strings to the list of ResourceGroupTargets in this ResourceGroup
|
boolean |
addAllResources(Collection<AppSvcResource> resources)
Adds a given collection of resources to this blueprint
|
Application |
addApplication(String id) |
AppSvcGroup |
addAppSvcGroup(String id) |
boolean |
addBlueprint(Blueprint blueprint)
Adds a Blueprint to the list of Blueprints in this Blueprint.
|
boolean |
addBlueprint(String blueprintName)
Adds a Blueprint to the list of Blueprints in this Blueprint identified by the blueprintName.
|
boolean |
addBlueprint(String blueprintName,
String version,
EnvironmentModelFileLocator locator)
Adds a Blueprint to the list of Blueprints in this Blueprint identified by the blueprintName.
|
CapacityConstraint |
addCapacityConstraint(String id)
Create a new capacity constraind for the provided ID.
|
ClasspathFileSystemResource |
addClasspathFileSystemResource(String id) |
CoherenceClusterSystemResource |
addCoherenceClusterSystemResource(String id)
Create a new Coherence cluster system resource using the provided ID.
|
ContextRequestClass |
addContextRequestClass(String id)
Create a new context request class.
|
boolean |
addExternalService(String externalService)
Adds a single external service to the list of external services for this Blueprint
|
FairShareRequestClass |
addFairShareRequestClass(String id)
Create a new fair share request class.
|
FileStore |
addFileStore(String id)
Create a new file store and assign it the provided ID.
|
ForeignJndiProvider |
addForeignJndiProvider(String id)
Create a foreign JNDI provider if one does not already exist.
|
GenericFileSystemResource |
addGenericFileSystemResource(String id) |
JdbcStore |
addJDBCStore(String id)
Create a new JDBC store and assign it the provided ID.
|
boolean |
addJDBCSystemResource(JDBCSystemResource resource)
Add a JDBC system resource to this blueprint.
|
JDBCSystemResource |
addJDBCSystemResource(String id)
Create a new JDBC system resource if ID does not exust.
|
JMSBridgeDestination |
addJMSBridgeDestination(String id)
Create a new JMS bridge destination.
|
JMSMessagingBridge |
addJMSMessagingBridge(String id) |
JMSServer |
addJMSServer(String id)
Create a new JMS server resource for the provided ID.
|
JMSSystemResource |
addJMSSystemResource(String id)
Create a new JMS system resource.
|
Library |
addLibrary(String id)
Create a new library resource and add it with the provided ID.
|
MailSession |
addMailSession(String id)
Add a new mail session with the provided ID
|
MaxThreadsConstraint |
addMaxThreadsConstraint(String id)
Create a new max threads constraint.
|
MinThreadsConstraint |
addMinThreadsConstraint(String id)
Create a new min threads constraint.
|
OsgiFramework |
addOsgiFramework(String id)
Create a new OsgiFramework resource and add it with the provided ID.
|
PathService |
addPathService(String id)
Create a new path service.
|
boolean |
addResource(AppSvcResource resource)
Adds a given resource to this blueprint
|
ResponseTimeRequestClass |
addResponseTimeRequestClass(String id)
Create a new response time request class.
|
SAFAgent |
addSAFAgent(String id) |
ServerGroup |
addServerGroup(String id) |
ShutdownClass |
addShutdownClass(String id)
Create a shutdown class if one doesn't already exist.
|
CompositeDeployment |
addSoaCompositeDeploymentResource(String id) |
StartupClass |
addStartupClass(String id)
Create a startup class if one doesn't already exist.
|
SystemPropertyResource |
addSystemPropertyResource(String id) |
WLDFSystemResource |
addWLDFSystemResource(String id)
Create a new WLDF system resource for the provided ID.
|
WorkManager |
addWorkManager(String id)
Create a new work manager for the provided ID.
|
<T extends AppSvcResource> |
findMatchingResource(T resourceToMatch)
Locate and return a matching resource.
|
Application |
getApplication(String id)
Locate and return an application by it's ID.
|
List<Application> |
getApplications()
Get the application resources within this blueprint.
|
AppSvcGroup |
getAppSvcGroup(String id) |
List<AppSvcGroup> |
getAppSvcGroups()
Get the application service groups within this blueprint.
|
<T extends AppSvcResource> |
getAppSvcResourceByType(Class<T> clazz)
Get the list of a particular resource type.
|
<T extends AppSvcResource> |
getAppSvcResourceByTypeAndId(Class<T> clazz,
String id)
Get a resource by type and ID.
|
List<Blueprint> |
getBlueprints()
Gets the list of Blueprints available in this Blueprint.
|
CapacityConstraint |
getCapacityConstraint(String id)
Locate and return the capacity constraint for the provided ID.
|
List<CapacityConstraint> |
getCapacityConstraints()
Get the capacity constraints within this blueprint.
|
Classpath |
getClasspath(String id) |
ClasspathFileSystemResource |
getClasspathFileSystemResource(String id) |
List<ClasspathFileSystemResource> |
getClasspathFileSystemResources()
Get the Classpath File System resources within this blueprint.
|
List<Classpath> |
getClasspaths()
Get the Classpath File System resources within this blueprint.
|
CoherenceClusterSystemResource |
getCoherenceClusterSystemResource(String id)
Return the Coherence cluster system resource for the provided ID.
|
List<CoherenceClusterSystemResource> |
getCoherenceClusterSystemResources()
Get the Coherence Cluster System Resources within this blueprint.
|
ContextRequestClass |
getContextRequestClass(String id)
Locate and return a context request class.
|
List<ContextRequestClass> |
getContextRequestClasses()
Get the Context Request Class resources within this blueprint.
|
List<String> |
getExternalServices()
Returns the list of external services in this Blueprint.
|
FairShareRequestClass |
getFairShareRequestClass(String id)
Locate and return a fair share request class by ID.
|
List<FairShareRequestClass> |
getFairShareRequestClasses()
Get the FairShareRequestClasses within this blueprint.
|
FileStore |
getFileStore(String id)
Return the file store for the provided ID.
|
List<FileStore> |
getFileStores()
Get the FileStores within the blueprint.
|
String |
getFMWVersionRange()
Returns the range of FMW releases that this model object is supported under.
|
ForeignJndiProvider |
getForeignJndiProvider(String id)
Locate and return a foreign JNDI provider.
|
List<ForeignJndiProvider> |
getForeignJndiProviders()
Get the ForeignJNDIProvider within this blueprint.
|
GenericFileSystemResource |
getGenericFileSystemResource(String id) |
List<GenericFileSystemResource> |
getGenericFileSystemResources()
Get the Generic File System resources within this blueprint.
|
JdbcStore |
getJDBCStore(String id)
Return the JDBC store matching the provided ID.
|
List<JdbcStore> |
getJDBCStores()
Get the JdbcStores within the blueprint.
|
JDBCSystemResource |
getJDBCSystemResource(String id)
Locate and return a JDBC system resource.
|
List<JDBCSystemResource> |
getJDBCSystemResources()
Get the JDBCSystemResources within this blueprint.
|
JMSBridgeDestination |
getJMSBridgeDestination(String id)
Locate and return a JMS bridge destination.
|
List<JMSBridgeDestination> |
getJMSBridgeDestinations()
Get the JMS Bridge Destinations within the blueprint.
|
JMSMessagingBridge |
getJMSMessagingBridge(String id) |
List<JMSMessagingBridge> |
getJMSMessagingBridges()
Get the JMS Messaging Bridges within the blueprint.
|
JMSServer |
getJMSServer(String id)
Locate and return the JMS server matching the provided ID.
|
List<JMSServer> |
getJMSServers()
Get the JMS Server resources within this blueprint.
|
JMSSystemResource |
getJMSSystemResource(String id)
Locate and return the JMS system resource for the provided ID.
|
List<JMSSystemResource> |
getJMSSystemResources()
Get the JMS System Resources within this blueprint.
|
List<Library> |
getLibraries()
Get the shared library resources within this blueprint.
|
Library |
getLibrary(String id)
Return the library matching the passed ID.
|
MailSession |
getMailSession(String id)
Return the mail session matching the provided ID
|
List<MailSession> |
getMailSessions()
Get the Mail Session resources within this blueprint.
|
MaxThreadsConstraint |
getMaxThreadsConstraint(String id)
Locate and return a max threads constraint.
|
List<MaxThreadsConstraint> |
getMaxThreadsConstraints()
Get the max thread constraints within this blueprint.
|
MinThreadsConstraint |
getMinThreadsConstraint(String id)
Locate and return a min threads constraint.
|
List<MinThreadsConstraint> |
getMinThreadsConstraints()
Get the min threads constraints within this blueprint.
|
String |
getName()
Returns the name.
|
OsgiFramework |
getOsgiFramework(String id)
Return the OsgiFramework matching the passed ID.
|
List<OsgiFramework> |
getOsgiFrameworks()
Get the shared OsgiFramework resources within this blueprint.
|
PathService |
getPathService(String id)
Locate and return a path service.
|
List<PathService> |
getPathServices()
Get the PathServices within the blueprint.
|
AppSvcResource |
getResourceById(String id)
Get a resource by ID.
|
List<AppSvcResource> |
getResources()
Get the list of all resources in this blueprint
|
ResponseTimeRequestClass |
getResponseTimeRequestClass(String id)
Locate and return a response time request class.
|
List<ResponseTimeRequestClass> |
getResponseTimeRequestClasses()
Get the ResponseTimeRequestClasses within this blueprint.
|
SAFAgent |
getSAFAgent(String id) |
List<SAFAgent> |
getSAFAgents()
Get the SAFAgents within the blueprint.
|
String |
getSchemaVersion()
Returns the version of the EnvSpec (XML) schema that applies to this model.
|
ServerGroup |
getServerGroup(String id) |
List<ServerGroup> |
getServerGroups()
Get the application service groups within this blueprint.
|
ShutdownClass |
getShutdownClass(String id)
Locate and return a shutdown class.
|
List<ShutdownClass> |
getShutdownClasses()
Return a list of all the shutdown classes in the blueprint.
|
CompositeDeployment |
getSoaCompositeDeploymentResource(String id) |
List<CompositeDeployment> |
getSoaCompositeResources()
Get the Generic File System resources within this blueprint.
|
StartupClass |
getStartupClass(String id)
Locate and return a startup class.
|
List<StartupClass> |
getStartupClasses()
Return a list of all startup classes in this blueprint.
|
SystemPropertyResource |
getSystemPropertyResource(String id) |
List<SystemPropertyResource> |
getSystemPropertyResources()
Get the System Property resources within this blueprint.
|
List<Template> |
getTemplates()
Returns the list of Templates in this Blueprint.
|
String |
getVersion()
Returns the consumer specified version of the this model file.
|
WLDFSystemResource |
getWLDFSystemResource(String id)
Return the WLDF system resource for the provided ID.
|
List<WLDFSystemResource> |
getWLDFSystemResources()
Get the WLDF System Resources within this blueprint.
|
WorkManager |
getWorkManager(String id)
Locate and return the work manager for the provided ID.
|
List<WorkManager> |
getWorkManagers()
Get the WorkManagers within this blueprint.
|
boolean |
removeAppSvcGroup(AppSvcGroup appSvcGroup) |
Blueprint |
removeAppSvcGroups() |
boolean |
removeResource(AppSvcResource resource)
Removes a given resource from the blueprint.
|
boolean |
removeServerGroup(ServerGroup serverGroup) |
Blueprint |
removeServerGroups() |
boolean |
removeTemplate(String name)
Remove any templates for the provided template name.
|
Blueprint |
setBlueprints(List<Blueprint> blueprints)
Sets the list of Blueprints in this Blueprint.
|
Blueprint |
setExternalServices(List<String> externalServices)
Sets the list of external services in this Blueprint.
|
Blueprint |
setFMWVersionRange(String fmwVersionRange)
Set the FMW version range.
|
Blueprint |
setName(String name)
Sets the name.
|
Blueprint |
setSchemaVersion(String schemaVersion)
Sets the version of the EnvSpec (XML) schema that applies to this model.
|
Blueprint |
setTemplates(List<Template> templates)
Sets the list of templates in this Blueprint.
|
Blueprint |
setVersion(String version)
Sets the consumer specified version of the their model file.
|
String |
toCompactString()
Returns a compact string representation of the object in XML format.
|
String |
toJsonCompactString()
Returns a compact string representation of the object in JSON format.
|
String |
toJsonString()
Returns a string representation of the object in JSON format.
|
String |
toString()
Returns a string representation of the object in XML format.
|
String |
toXmlCompactString()
Returns a compact string representation of the object in XML format.
|
String |
toXmlString()
Returns a string representation of the object in XML format.
|
public boolean addBlueprint(Blueprint blueprint)
blueprint
- The Blueprint to be addedpublic boolean addBlueprint(String blueprintName, String version, EnvironmentModelFileLocator locator) throws FMWEnvSpecException
blueprintName
- the name of the Blueprint to be addedversion
- the version of the Blueprint to be added or null if any version is acceptablelocator
- an EnvironmentModelFileLocator locator that has been initialized with the paths that are to
be searched when finding the Blueprint or null if only the OracleHome needs to be searchedFMWEnvSpecException
- the Blueprint could not be loadedpublic boolean addBlueprint(String blueprintName) throws FMWEnvSpecException
blueprintName
- the name of the blueprint to be addedFMWEnvSpecException
- The Blueprint could not be loadedpublic List<Blueprint> getBlueprints()
public List<String> getExternalServices()
public String getName()
getName
in interface oracle.fmwplatform.envspec.common.Versioned
public String getSchemaVersion()
getSchemaVersion
in interface oracle.fmwplatform.envspec.common.Versioned
public List<Template> getTemplates()
public String getVersion()
getVersion
in interface oracle.fmwplatform.envspec.common.Versioned
public String getFMWVersionRange()
getFMWVersionRange
in interface oracle.fmwplatform.envspec.common.Versioned
public Blueprint setFMWVersionRange(String fmwVersionRange)
setFMWVersionRange
in interface oracle.fmwplatform.envspec.common.Versioned
fmwVersionRange
- the version rangepublic Blueprint setBlueprints(List<Blueprint> blueprints)
blueprints
- The Blueprint list to be used by this Blueprintpublic Blueprint setExternalServices(List<String> externalServices)
externalServices
- the list of externalServices to be used by this Blueprintpublic boolean addAllExternalServices(List<String> externalServices)
externalServices
- list of String objects to addtrue
if the list of ExternalServices changed in this Blueprint as a result of the callIllegalArgumentException
- if input parameter is nullpublic boolean addExternalService(String externalService)
externalService
- string value for the external servicetrue
if the list of ExternalServices changed in this Blueprint as a result of the callIllegalArgumentException
- if input parameter is nullpublic Blueprint setName(String name)
oracle.fmwplatform.envspec.common.Versioned
setName
in interface oracle.fmwplatform.envspec.common.Versioned
name
- the namepublic Blueprint setSchemaVersion(String schemaVersion)
oracle.fmwplatform.envspec.common.Versioned
setSchemaVersion
in interface oracle.fmwplatform.envspec.common.Versioned
schemaVersion
- the version of the EnvSpec (XML) schema that applies to this modelpublic Blueprint setTemplates(List<Template> templates)
templates
- the Templates to be used by this Blueprintpublic boolean removeTemplate(String name)
name
- the template name to be removedpublic Blueprint setVersion(String version)
oracle.fmwplatform.envspec.common.Versioned
setVersion
in interface oracle.fmwplatform.envspec.common.Versioned
version
- the consumer specified version of the their model file.public <T extends AppSvcResource> List<T> getAppSvcResourceByType(Class<T> clazz)
T
- T the resource typeclazz
- the resource type classpublic <T extends AppSvcResource> T getAppSvcResourceByTypeAndId(Class<T> clazz, String id)
T
- the resource typeclazz
- the resource type classid
- the IDpublic AppSvcResource getResourceById(String id)
id
- the resource ID to findpublic List<AppSvcResource> getResources()
public <T extends AppSvcResource> T findMatchingResource(T resourceToMatch)
resourceToMatch
- the resource to be matchedpublic List<Application> getApplications()
public Application getApplication(String id)
id
- the application ID to locatepublic Application addApplication(String id)
public List<Library> getLibraries()
public Library getLibrary(String id)
id
- the library ID to be matchedpublic Library addLibrary(String id)
id
- the ID for the new librarypublic List<MailSession> getMailSessions()
public MailSession getMailSession(String id)
id
- the mail session ID to matchpublic MailSession addMailSession(String id)
id
- the mail session ID to locatepublic List<CoherenceClusterSystemResource> getCoherenceClusterSystemResources()
public CoherenceClusterSystemResource getCoherenceClusterSystemResource(String id)
id
- the ID to be locatedpublic CoherenceClusterSystemResource addCoherenceClusterSystemResource(String id)
id
- the ID for the new resourcepublic List<WLDFSystemResource> getWLDFSystemResources()
public WLDFSystemResource getWLDFSystemResource(String id)
id
- the resource ID to be locatedpublic WLDFSystemResource addWLDFSystemResource(String id)
id
- the ID to be used for the resourcepublic List<JdbcStore> getJDBCStores()
public JdbcStore getJDBCStore(String id)
id
- the ID to matchpublic JdbcStore addJDBCStore(String id)
id
- the ID for the new JDBC storepublic List<FileStore> getFileStores()
public FileStore getFileStore(String id)
id
- the resource ID to be locatedpublic FileStore addFileStore(String id)
id
- the ID for the new file storepublic List<JMSServer> getJMSServers()
public JMSServer getJMSServer(String id)
id
- the server ID to be locatedpublic JMSServer addJMSServer(String id)
id
- the ID to be asigned to the resourcepublic List<JMSSystemResource> getJMSSystemResources()
public JMSSystemResource getJMSSystemResource(String id)
id
- the resource ID to be locatedpublic JMSSystemResource addJMSSystemResource(String id)
id
- the resource ID to be assignedpublic List<WorkManager> getWorkManagers()
public WorkManager getWorkManager(String id)
id
- the resource ID to be locatedpublic WorkManager addWorkManager(String id)
id
- the resource ID to be assignedpublic List<CapacityConstraint> getCapacityConstraints()
public CapacityConstraint getCapacityConstraint(String id)
id
- the resource ID to be locatedpublic CapacityConstraint addCapacityConstraint(String id)
id
- the resource ID to be assignedpublic List<FairShareRequestClass> getFairShareRequestClasses()
public FairShareRequestClass getFairShareRequestClass(String id)
id
- the resource ID to be locatedpublic FairShareRequestClass addFairShareRequestClass(String id)
id
- the resource ID to be assignedpublic List<ResponseTimeRequestClass> getResponseTimeRequestClasses()
public ResponseTimeRequestClass getResponseTimeRequestClass(String id)
id
- the resource ID to be locatedpublic ResponseTimeRequestClass addResponseTimeRequestClass(String id)
id
- the resource ID to be assignedpublic List<ContextRequestClass> getContextRequestClasses()
public ContextRequestClass getContextRequestClass(String id)
id
- the resource ID to be locatedpublic ContextRequestClass addContextRequestClass(String id)
id
- the resource ID to be assignedpublic List<MaxThreadsConstraint> getMaxThreadsConstraints()
public MaxThreadsConstraint getMaxThreadsConstraint(String id)
id
- the resource ID to be locatedpublic MaxThreadsConstraint addMaxThreadsConstraint(String id)
id
- the resource ID to be assignedpublic List<MinThreadsConstraint> getMinThreadsConstraints()
public MinThreadsConstraint getMinThreadsConstraint(String id)
id
- the resource ID to be locatedpublic MinThreadsConstraint addMinThreadsConstraint(String id)
id
- the resource ID to be assignedpublic List<JDBCSystemResource> getJDBCSystemResources()
public JDBCSystemResource getJDBCSystemResource(String id)
id
- the resource ID to be locatedpublic JDBCSystemResource addJDBCSystemResource(String id)
id
- the resource ID to be assignedpublic boolean addJDBCSystemResource(JDBCSystemResource resource)
resource
- the resource to be addedpublic List<ForeignJndiProvider> getForeignJndiProviders()
public ForeignJndiProvider getForeignJndiProvider(String id)
id
- the resource ID to locatepublic ForeignJndiProvider addForeignJndiProvider(String id)
id
- the resource IDpublic List<StartupClass> getStartupClasses()
public StartupClass getStartupClass(String id)
id
- the resource ID to be locatedpublic StartupClass addStartupClass(String id)
id
- the resource ID for the startup classpublic List<ShutdownClass> getShutdownClasses()
public ShutdownClass getShutdownClass(String id)
id
- the resource ID to be locatedpublic ShutdownClass addShutdownClass(String id)
id
- the resource ID of the shutdown classpublic List<PathService> getPathServices()
public PathService getPathService(String id)
id
- the resource id to be locatedpublic PathService addPathService(String id)
id
- the resource ID to be assignedpublic List<JMSBridgeDestination> getJMSBridgeDestinations()
public JMSBridgeDestination getJMSBridgeDestination(String id)
id
- the resource ID to be locatedpublic JMSBridgeDestination addJMSBridgeDestination(String id)
id
- the resource ID to be assignedpublic List<JMSMessagingBridge> getJMSMessagingBridges()
public JMSMessagingBridge getJMSMessagingBridge(String id)
public JMSMessagingBridge addJMSMessagingBridge(String id)
public List<OsgiFramework> getOsgiFrameworks()
public OsgiFramework getOsgiFramework(String id)
id
- the OsgiFramework ID to be matchedpublic OsgiFramework addOsgiFramework(String id)
id
- the ID for the new OsgiFrameworkpublic List<SAFAgent> getSAFAgents()
public List<GenericFileSystemResource> getGenericFileSystemResources()
public GenericFileSystemResource getGenericFileSystemResource(String id)
public GenericFileSystemResource addGenericFileSystemResource(String id)
public List<CompositeDeployment> getSoaCompositeResources()
public CompositeDeployment getSoaCompositeDeploymentResource(String id)
public CompositeDeployment addSoaCompositeDeploymentResource(String id)
public List<ClasspathFileSystemResource> getClasspathFileSystemResources()
public ClasspathFileSystemResource getClasspathFileSystemResource(String id)
public ClasspathFileSystemResource addClasspathFileSystemResource(String id)
public List<Classpath> getClasspaths()
public List<SystemPropertyResource> getSystemPropertyResources()
public SystemPropertyResource getSystemPropertyResource(String id)
public SystemPropertyResource addSystemPropertyResource(String id)
public boolean addResource(AppSvcResource resource)
resource
- to addpublic boolean addAllResources(Collection<AppSvcResource> resources)
resources
- collection of resources to addpublic boolean removeResource(AppSvcResource resource)
resource
- the resource to be removedpublic List<AppSvcGroup> getAppSvcGroups()
public AppSvcGroup getAppSvcGroup(String id)
public AppSvcGroup addAppSvcGroup(String id)
public boolean removeAppSvcGroup(AppSvcGroup appSvcGroup)
public Blueprint removeAppSvcGroups()
public List<ServerGroup> getServerGroups()
public ServerGroup getServerGroup(String id)
public ServerGroup addServerGroup(String id)
public boolean removeServerGroup(ServerGroup serverGroup)
public Blueprint removeServerGroups()
public String toXmlCompactString()
public String toXmlString()
public String toJsonCompactString()
public String toJsonString()
public String toCompactString()