|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.datapower.wamt.clientAPI.DeploymentPolicy
public class DeploymentPolicy
This class represents the deployment policy that is to be applied to a Domain
during deployment. This deployment policy will not reside on the DataPower device after domain
deployment because it is only applied at deploy-time.
This behavior of this class is controlled by the Domain
class, and as such, all
of the methods in this class are for internal use only.
A DeploymentPolicy
is tightly coupled with a Domain
. When
a Domain
object is created an empty DeploymentPolicy
object is
created within it. The settings for a deployment policy must be specified via the
setDeploymentPolicy(url, policydomain, policyObjectName)
method on
Domain
. Calling setDeploymentPolicy(null,
null, null)
on Domain
sets the DeploymentPolicy
to an empty state.
When calling setPolicyExport on Domain
, the URLSource is a reference to a configuration blob from a
device, the domainName and policyObjectName serve as an "index" into the blob, pointing to
the domain, and associated deployment policy within the blob. The domainName specified does
not have to match the name of the Domain
that owns this
DeploymentPolicy
object.
Domain
,
DeploymentPolicyVersion
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT_2009_2013
|
Fields inherited from interface com.ibm.datapower.wamt.clientAPI.Versionable |
---|
COPYRIGHT_2009_2010, SCM_REVISION |
Method Summary | |
---|---|
java.lang.String |
getAbsoluteDisplayName()
Get a human-readable name that represents this object. |
byte[] |
getCachedBytes()
|
Domain |
getDomain()
|
int |
getHighestVersionNumber()
Get the highest version number of all the DeploymentPolicyVersions in this DeploymentPolicy. |
java.lang.String |
getName()
Only used for stored instance. |
java.lang.String |
getPolicyDomainName()
Returns the name of the domain that contains the deployment policy in the blob. |
java.lang.String |
getPolicyObjectName()
Returns the name of the deployment policy object to use. |
DeploymentPolicyType |
getPolicyType()
Returns the deployment policy enum type. |
URLSource |
getPolicyURLSource()
Returns the policy URL source. |
java.lang.String |
getPrimaryKey()
|
java.lang.String |
getRelativeDisplayName()
Get a human-readable name that represents this object. |
DeploymentPolicyVersion |
getVersion(int targetVersionNumber)
Get the specified Version of this Versionable object. |
DeploymentPolicyVersion[] |
getVersions()
Get all the versions that exist of this Versionable object. |
void |
setPolicyExport(URLSource url,
java.lang.String policyDomain,
java.lang.String policyObjName)
When calling setPolicyExport, the URLSource is a reference to the configuration blob, the domainName and policyObjectName serve as an "index" into the blob, pointing to the domain, and associated deployment policy within the blob. |
void |
setPolicyNone()
This method is called when null parameters are passed to
setDeploymentPolicy(null, null, null) in Domain |
void |
setPolicyXML(URLSource url)
When calling setPolicyXML, the URLSource is a reference to a deployment policy in XML format. |
java.lang.String |
toString()
Get a String representation of this object for the purpose of debugging or tracing. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COPYRIGHT_2009_2013
Method Detail |
---|
public void setPolicyExport(URLSource url, java.lang.String policyDomain, java.lang.String policyObjName) throws DeletedException, AlreadyExistsInRepositoryException, DatastoreException, InvalidParameterException
Domain
that owns this DeploymentPolicy
object.
url
- - is a URLSource that points to a configuration blob. This parameter is required.policyDomain
- - this is the first piece of information used to find the deployment policy within
the configuration source specified by the URLSource. This parameter is only required if the
source is a backup, since a backup may contain multiple domains.policyObjName
- - this is the second piece of information used to find the deployment policy within
the configuration source specified by the URLSource. This parameter is required.public void setPolicyXML(URLSource url) throws DeletedException, DatastoreException, InvalidParameterException
<Policy>
<ModifiedConfig>
<Match>*/*/wsm/wsm-endpointrewrite?Name=simplyWSP&Property=WSEndpointRemoteRewriteRule/RemoteEndpointPort&Value=12345</Match>
<Type>change</Type>
<Property/>
<Value>12345</Value>
</ModifiedConfig>
<ModifiedConfig>
<Match>*/*/wsm/wsm-endpointrewrite?Name=simplyWSP&Property=WSEndpointRemoteRewriteRule/RemoteEndpointHostname&Value=.*</Match>
<Type>change</Type>
<Property/>
<Value>new.hostname.value</Value>
</ModifiedConfig>
</Policy>
url
- - is a URLSource that points to a deployment policy in XML format. This parameter is required.public void setPolicyNone() throws DeletedException, AlreadyExistsInRepositoryException, DatastoreException
null
parameters are passed to
setDeploymentPolicy(null, null, null)
in Domain
public byte[] getCachedBytes()
public DeploymentPolicyType getPolicyType() throws DeletedException
public URLSource getPolicyURLSource() throws DeletedException
public java.lang.String getPolicyDomainName() throws DeletedException
public java.lang.String getPolicyObjectName() throws DeletedException
public java.lang.String getName() throws DeletedException
public Domain getDomain() throws DeletedException
public java.lang.String getPrimaryKey() throws DeletedException
public DeploymentPolicyVersion[] getVersions() throws DeletedException
Versionable
This object should implement the Versionable
interface,
and versions of this object should implement the Version
interface.
getVersions
in interface Versionable
Versionable.getVersion(int)
public DeploymentPolicyVersion getVersion(int targetVersionNumber) throws DeletedException
Versionable
getVersion
in interface Versionable
targetVersionNumber
- the specified version to get of this object.
Versionable.getVersions()
public int getHighestVersionNumber() throws DeletedException
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getRelativeDisplayName()
public java.lang.String getAbsoluteDisplayName()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |