|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TradingPartnerMBean
This class represents a business entity that is authorized to send and receive business messages for a defined service.
ServiceMBean
Field Summary | |
---|---|
static String |
DISABLED
|
static String |
ENABLED
|
static String |
LOCAL
|
static String |
REMOTE
|
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean |
---|
DEFAULT_EMPTY_BYTE_ARRAY |
Method Summary | |
---|---|
void |
addCertificate(String name,
String type,
String password,
boolean passwordEncrypted,
String passwordAlias,
String certFile,
String keyFile,
boolean importInKeyStore)
Add a certificate for the Trading Partner. |
void |
addEBXMLBinding(String name,
String businessProtocolName,
String businessProtocolVersion,
boolean isDefault,
boolean isSignatureRequired,
boolean isReceiptSignatureRequired,
String deliverySematics,
int retryCount,
String retryInterval,
String persistDuration)
Adds a EBXML Binding for this Trading Partner |
void |
addExtendedPropertySet(String name,
String description,
String notes,
String xml)
Adds a custom XML extensions for the TPM. |
void |
addExtendedPropertySetInternal(String name,
String description,
String notes,
Element xml)
|
void |
addReferenceToEBXMLBinding(EBXMLBindingMBean mbean)
Internal Use Only - Adds a ebxml Binding |
void |
addReferenceToRosettaNetBinding(RosettaNetBindingMBean mbean)
Internal Use Only - Adds a RosettaNet Binding |
void |
addReferenceToWebServiceBinding(WebServiceBindingMBean mbean)
Internal Use Only - Adds a Web Service Binding |
void |
addRosettaNetBinding(String name,
String businessProtocolName,
String businessProtocolVersion,
boolean isDefault,
boolean isSignatureRequired,
boolean isReceiptSignatureRequired,
String messageDigestAlgorithm,
String ciperAlgorithm,
String encryptionLevel,
int retryCount,
String retryInterval,
String processTimeout)
Adds a Rosettanet Binding for this Trading Partner |
void |
addWebServiceBinding(String name)
Adds a WebService Binding for this trading parner |
void |
disable()
Internal Use Only - Retrieves the TPM Interface. |
void |
enable()
Internal Use Only - Retrieves the TPM Interface. |
String |
getAddress()
Contact address of the trading partner |
String |
getBusinessId()
A business ID is used with a trading partner name to identify a party in message exchange. |
String |
getBusinessIdType()
Meaningful name for the business ID. |
String |
getDescription()
Retrieves the short textual description of this entity. |
String |
getEmail()
Specifies the email address of the trading partner |
String |
getFax()
Fax number for the trading partner |
String |
getNotes()
Retrieves the additional description to of this entity. |
String |
getPartnerName()
Returns the name of this Trading Partner. |
String |
getPartnerType()
Specifies where the trading partner is hosted locally or represents an external remote trading partner. |
String |
getPhone()
Contact phone number of the trading partner |
String |
getStatus()
Specifies the status of the current partner profile. |
String |
getWLUserName()
Name of the WebLogic Server users to whom the trading partner certificate should be mapped when messages are sent by that trading partner. |
boolean |
isDefaultPartner()
Indicates that this trading partner should be used as the default trading partner for sending or receiving messages for the local host system. |
boolean |
isEnabled()
Internal Use Only - Retrieves the TPM Interface. |
void |
removeAllBindings()
Removes all the bindings for this trading partner |
void |
removeAllExtendedPropertySet()
Removes all the Extended PropertySets configured for this trading partner |
void |
removeBinding(String name)
Deletes the binding for the trading partner, with the specified name |
void |
removeCertificate(String name,
boolean removeCertFromKeyStore)
Remove a certificate for the Trading Partner. |
void |
removeExtendedPropertySet(String name)
Remove a custom extensions for the trading partner |
void |
removeReferenceForBinding(BindingMBean mbean)
Internal Use Only - Removes the binding |
BindingMBean[] |
retrieveAllBindings()
Returns all the bindings configured for the Trading Partner. |
CertificateMBean[] |
retrieveAllCertificates()
Returns an all the certificateMBean's configured for the trading partner. |
EBXMLBindingMBean[] |
retrieveAllEbXmlBindings()
Retrieves all Ebxml Bindings configured for the Trading Partner. |
ExtendedPropertySetMBean[] |
retrieveAllExtendedPropertySets()
Retrieves all Extended Property Sets for the Trading Partner. |
RosettaNetBindingMBean[] |
retrieveAllRosettaNetBindings()
Retrieves all RosettaNet Bindings configured for the Trading Partner . |
WebServiceBindingMBean[] |
retrieveAllWebServiceBindings()
Retrieves all Web Service Bindings for the Trading Partner. |
BindingMBean |
retrieveBindingByName(String name)
Retrieves an instance of a Binding for the Trading Partner. |
Certificate |
retrieveCertificate(String name)
Retrieves the X509 certificate from the Key Store, for the alias |
CertificateMBean |
retrieveCertificateByName(String name)
Retrieves a particular certificateMBean for a trading partner, which is identified by name. |
CertificateMBean[] |
retrieveCertificatesByType(String type)
Returns an all the matching certificateMBean's of the type specified configured for the trading partner. |
EBXMLBindingMBean |
retrieveDefaultEbxmlBinding(String version)
Retrieves the default Ebxml binding instance |
RosettaNetBindingMBean |
retrieveDefaultRNBinding(String version)
Retrieves the default RosettaNet binding instance |
EBXMLBindingMBean |
retrieveEBXMLBinding(String name)
Retrieves an instance of EBXML Binding identified name |
ExtendedPropertySetMBean |
retrieveExtendedPropertySet(String name)
Returns the instance of the Extended Property Se, identified by name |
RosettaNetBindingMBean |
retrieveRosettaNetBinding(String name)
Returns an instance of RosettaNet Binding identified by name |
TradingPartnerMgmtMBean |
retrieveTradingPartnerMgmt()
Internal Use Only - Retrieves the TPM Interface. |
WebServiceBindingMBean |
retrieveWebServiceBinding(String name)
Retrieves the instance of WebService Binding indentified by name |
void |
setAddress(String newValue)
Contact address of the trading partner |
void |
setBusinessId(String newValue)
Registers the business ID is used with a trading partner name to identify a party in message exchange. |
void |
setBusinessIdType(String newValue)
Meaningful name for the business ID. |
void |
setDefaultPartner(boolean newValue)
Represents this trading partner, to be the default trading partner. |
void |
setDescription(String newValue)
Specifies the description for this trading partner |
void |
setEmail(String newValue)
Registers the email of the trading partner |
void |
setFax(String newValue)
Fax number for the trading partner. |
void |
setNotes(String newValue)
Registers the additional textual documentation |
void |
setPartnerName(String newValue)
Registers the name of this trading partner. |
void |
setPartnerType(String newValue)
Registers where the trading partner is hosted locally or represents an external remote trading partner |
void |
setPhone(String newValue)
Registers the contact phone number of the trading partner |
void |
setStatus(String newValue)
Registers the status of the current partner profile. |
void |
setWLUserName(String newValue)
Registers the aame of the WebLogic Server users to whom the trading partner certificate should be mapped when messages are sent by that trading partner. |
void |
updateAll(String businessId,
String businessIdType,
boolean isDefault,
String status,
String type,
String description,
String notes,
String address,
String fax,
String phone,
String email,
String userName)
Updates the trading partner |
Methods inherited from interface com.bea.wli.tpm.management.configuration.TPMBaseMBean |
---|
fromXML, getDelegateObject, isActive, publish, remove, setActive, setDelegateObject, toXML, toXMLInternal, update, updateInternal |
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean |
---|
freezeCurrentValue, getComments, getName, isDefaultedMBean, isPersistenceEnabled, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setPersistenceEnabled, touch, unSet |
Methods inherited from interface weblogic.management.WebLogicMBean |
---|
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent |
Methods inherited from interface javax.management.DynamicMBean |
---|
getAttribute, getAttributes, invoke, setAttribute, setAttributes |
Methods inherited from interface javax.management.MBeanRegistration |
---|
postDeregister, postRegister, preDeregister, preRegister |
Methods inherited from interface javax.management.NotificationBroadcaster |
---|
addNotificationListener, getNotificationInfo, removeNotificationListener |
Methods inherited from interface weblogic.descriptor.DescriptorBean |
---|
addBeanUpdateListener, addPropertyChangeListener, createChildCopy, createChildCopyIncludingObsolete, getDescriptor, getParentBean, isEditable, removeBeanUpdateListener, removePropertyChangeListener |
Field Detail |
---|
static final String LOCAL
static final String REMOTE
static final String ENABLED
static final String DISABLED
Method Detail |
---|
String getPartnerName()
void setPartnerName(String newValue) throws javax.management.InvalidAttributeValueException
newValue
- - the name of the set
javax.management.InvalidAttributeValueException
- - If the name cannot be set or the name has
invalid characters.String getDescription()
void setDescription(String newValue) throws javax.management.InvalidAttributeValueException
newValue
- - description text, can be null
javax.management.InvalidAttributeValueException
String getNotes()
getNotes
in interface weblogic.management.configuration.ConfigurationMBean
void setNotes(String newValue) throws javax.management.InvalidAttributeValueException
setNotes
in interface weblogic.management.configuration.ConfigurationMBean
newValue
- - the text to specify
javax.management.InvalidAttributeValueException
String getPartnerType()
void setPartnerType(String newValue) throws javax.management.InvalidAttributeValueException
newValue
- - type of partner
javax.management.InvalidAttributeValueException
- - If not one of the types specifiedboolean isDefaultPartner()
void setDefaultPartner(boolean newValue) throws javax.management.InvalidAttributeValueException
newValue
- - new value for attribute Default
javax.management.InvalidAttributeValueException
String getEmail()
void setEmail(String newValue) throws javax.management.InvalidAttributeValueException
newValue
- - email id of tp
javax.management.InvalidAttributeValueException
String getAddress()
void setAddress(String newValue) throws javax.management.InvalidAttributeValueException
newValue
- - the address information
javax.management.InvalidAttributeValueException
String getPhone()
void setPhone(String newValue) throws javax.management.InvalidAttributeValueException
newValue
- - new value for attribute Phone
javax.management.InvalidAttributeValueException
String getFax()
void setFax(String newValue) throws javax.management.InvalidAttributeValueException
newValue
- - fax number of the trading partner
javax.management.InvalidAttributeValueException
String getStatus()
boolean isEnabled()
void setStatus(String newValue) throws javax.management.InvalidAttributeValueException
newValue
- - new value for attribute Status
javax.management.InvalidAttributeValueException
- - If the status is not one of the aboveString getWLUserName()
void setWLUserName(String newValue) throws javax.management.InvalidAttributeValueException
newValue
- - user name
javax.management.InvalidAttributeValueException
String getBusinessId()
void setBusinessId(String newValue) throws javax.management.InvalidAttributeValueException
newValue
- - new value for attribute BusinessId
javax.management.InvalidAttributeValueException
String getBusinessIdType()
void setBusinessIdType(String newValue) throws javax.management.InvalidAttributeValueException
newValue
- - business id type
javax.management.InvalidAttributeValueException
void enable() throws ConfigurationException
ConfigurationException
void disable() throws ConfigurationException
ConfigurationException
void addExtendedPropertySet(String name, String description, String notes, String xml) throws ConfigurationException, javax.management.InstanceAlreadyExistsException
name
- - name of property setdescription
- - short description property setnotes
- - additional textual information for property setxml
- - Custom of the XML
ConfigurationException
javax.management.InstanceAlreadyExistsException
void addExtendedPropertySetInternal(String name, String description, String notes, Element xml) throws ConfigurationException, javax.management.InstanceAlreadyExistsException
name
- - name of property setdescription
- - short description property setnotes
- - additional textual information for property setxml
- - root element of the custom XML
ConfigurationException
javax.management.InstanceAlreadyExistsException
void removeExtendedPropertySet(String name) throws DeleteException, javax.management.InstanceNotFoundException
name
- - name of property set
DeleteException
javax.management.InstanceNotFoundException
void addCertificate(String name, String type, String password, boolean passwordEncrypted, String passwordAlias, String certFile, String keyFile, boolean importInKeyStore) throws ConfigurationException, javax.management.InstanceAlreadyExistsException
name
- - Name of the certificate. This name would be the alias of the certificate in Java Key Storetype
- - Type of the certificate. Possible types are 'SIGNATURE','ENCRYPTION', 'SERVER', 'CLIENT'password
- - No longer used. Provided value is ignored.passwordEncrypted
- - No longer used. Provided value is ignored.passwordAlias
- - alias name in password storecertFile
- - Absolute file location on the file system. This can be null.
In this case, no certificate would be imported to the key store. The certificate could be
imported at a later stage, using the CertificateMBean.keyFile
- - Absolute file location of the private key for the certificate. if this is
specified then certFile must also be provided.importInKeyStore
- - Should the certificate be imported in keystore
ConfigurationException
- - If unable to load the certificate into keystore, or the url is malformed.
javax.management.InstanceAlreadyExistsException
- - If a CertificateMBean object already exists.void removeCertificate(String name, boolean removeCertFromKeyStore) throws DeleteException, javax.management.InstanceNotFoundException
name
- - Name of the certificate alias in Java Key Store
DeleteException
javax.management.InstanceNotFoundException
CertificateMBean[] retrieveCertificatesByType(String type) throws ManagementException
Possible types are
type
- - the certificate type
ManagementException
CertificateMBean[] retrieveAllCertificates() throws ManagementException
ManagementException
CertificateMBean retrieveCertificateByName(String name) throws ManagementException, javax.management.InstanceNotFoundException
name
- - the alias of certificate
ManagementException
- - If errror in lookup
javax.management.InstanceNotFoundException
- - If no certificate, with name existsCertificate retrieveCertificate(String name) throws ManagementException, javax.management.InstanceNotFoundException
name
- - Name of the certificate alias in Java Key Store
ManagementException
javax.management.InstanceNotFoundException
- - If no certificate with alias existsTradingPartnerMgmtMBean retrieveTradingPartnerMgmt() throws ManagementException
ManagementException
void addEBXMLBinding(String name, String businessProtocolName, String businessProtocolVersion, boolean isDefault, boolean isSignatureRequired, boolean isReceiptSignatureRequired, String deliverySematics, int retryCount, String retryInterval, String persistDuration) throws ConfigurationException, javax.management.InstanceAlreadyExistsException
name
- - name of the bindingbusinessProtocolName
- - business procotolbusinessProtocolVersion
- - version of this buisness ProtocolisDefault
- - Is this the default bindingisSignatureRequired
- - Is signature requiredisReceiptSignatureRequired
- - Is Receipt Signature signature requireddeliverySematics
- - Delivery SematicsretryCount
- - Retry CountretryInterval
- - retryInterval in 0y0m0dt0h0m0spersistDuration
- - Persist Duration in 0y0m0dt0h0m0s
ConfigurationException
- - If unable to add binding
javax.management.InstanceAlreadyExistsException
- - If binding wuith name already existsEBXMLBindingMBean
void addRosettaNetBinding(String name, String businessProtocolName, String businessProtocolVersion, boolean isDefault, boolean isSignatureRequired, boolean isReceiptSignatureRequired, String messageDigestAlgorithm, String ciperAlgorithm, String encryptionLevel, int retryCount, String retryInterval, String processTimeout) throws ConfigurationException, javax.management.InstanceAlreadyExistsException
name
- - Name of the bindingbusinessProtocolName
- - Name of the business procotolbusinessProtocolVersion
- - Version of this buisness ProtocolisDefault
- - Is this the default bindingisSignatureRequired
- - Is signature requiredisReceiptSignatureRequired
- - Is Receipt Signature signature requiredciperAlgorithm
- - ciper AlgorithmmessageDigestAlgorithm
- - Message Digest AlgorithmencryptionLevel
- - encryptionLevelretryCount
- - Retry CountretryInterval
- - retryInterval in 0y0m0dt0h0m0sprocessTimeout
- - Process Timeout in 0y0m0dt0h0m0s
ConfigurationException
- - If unable to add binding
javax.management.InstanceAlreadyExistsException
- - If binding wuith name already existsRosettaNetBindingMBean
void addWebServiceBinding(String name) throws ConfigurationException, javax.management.InstanceAlreadyExistsException
name
- - Name of the binding
ConfigurationException
- - If unable to add binding
javax.management.InstanceAlreadyExistsException
- - If binding wuith name already existsvoid removeBinding(String name) throws DeleteException, javax.management.InstanceNotFoundException
name
- - Name of the binding
DeleteException
- - If unable to remove the binding
javax.management.InstanceNotFoundException
- - If the binding, with the name does not existsvoid removeReferenceForBinding(BindingMBean mbean) throws DeleteException, javax.management.InstanceNotFoundException
mbean
- - binding object
DeleteException
javax.management.InstanceNotFoundException
void removeAllBindings() throws DeleteException
DeleteException
void removeAllExtendedPropertySet() throws DeleteException
DeleteException
BindingMBean[] retrieveAllBindings() throws ManagementException
ManagementException
EBXMLBindingMBean
,
RosettaNetBindingMBean
,
WebServiceBindingMBean
BindingMBean retrieveBindingByName(String name) throws ManagementException
null is returned if binding with name does not exists
- Throws:
ManagementException
- - If the instance with name does not exists
EBXMLBindingMBean[] retrieveAllEbXmlBindings() throws ManagementException
null is returned if binding with name does not exists
- Throws:
ManagementException
RosettaNetBindingMBean[] retrieveAllRosettaNetBindings() throws ManagementException
null is returned if binding with name does not exists
- Throws:
ManagementException
WebServiceBindingMBean[] retrieveAllWebServiceBindings() throws ManagementException
ManagementException
ExtendedPropertySetMBean[] retrieveAllExtendedPropertySets() throws ManagementException
ManagementException
EBXMLBindingMBean retrieveEBXMLBinding(String name) throws ManagementException
name
- - name of Binding, null is returned if binding with name does not exists
- Throws:
ManagementException
RosettaNetBindingMBean retrieveRosettaNetBinding(String name) throws ManagementException
name
- - name of Binding, null is returned if binding with name does not exists
- Throws:
ManagementException
WebServiceBindingMBean retrieveWebServiceBinding(String name) throws ManagementException
name
- - name of Binding, null is returned if binding with name does not exists
- Throws:
ManagementException
ExtendedPropertySetMBean retrieveExtendedPropertySet(String name) throws ManagementException
name
- - name of extended property set, null is returned if name does not exists
- Throws:
ManagementException
void addReferenceToEBXMLBinding(EBXMLBindingMBean mbean) throws ConfigurationException, javax.management.InstanceAlreadyExistsException
mbean
- - Ebxml Binding MBean
ConfigurationException
javax.management.InstanceAlreadyExistsException
void addReferenceToRosettaNetBinding(RosettaNetBindingMBean mbean) throws ConfigurationException, javax.management.InstanceAlreadyExistsException
mbean
- - Rosettanet Binding MBean
ConfigurationException
javax.management.InstanceAlreadyExistsException
void addReferenceToWebServiceBinding(WebServiceBindingMBean mbean) throws ConfigurationException, javax.management.InstanceAlreadyExistsException
mbean
- - Web Service Binding MBean
ConfigurationException
javax.management.InstanceAlreadyExistsException
RosettaNetBindingMBean retrieveDefaultRNBinding(String version) throws ManagementException, javax.management.InstanceNotFoundException
version
- - protocol version, valid values are 1.1 and 2.0
ManagementException
javax.management.InstanceNotFoundException
EBXMLBindingMBean retrieveDefaultEbxmlBinding(String version) throws ManagementException, javax.management.InstanceNotFoundException
version
- - protocol version, valid values are 1.0 and 2.0
ManagementException
javax.management.InstanceNotFoundException
void updateAll(String businessId, String businessIdType, boolean isDefault, String status, String type, String description, String notes, String address, String fax, String phone, String email, String userName) throws javax.management.InvalidAttributeValueException, UpdateException, ObjectActiveException
businessId
- - business-id of party identifier to be usedbusinessIdType
- - business-id Type of party identifier to be usedisDefault
- - Is the trading Partner Defaulttype
- - Type of Trading Partner(LOCAL or REMOTE)description
- - Descriptionnotes
- - Notesaddress
- - Addressfax
- - Fax Numberphone
- - Phone Numberemail
- - Email AddressuserName
- - WLS User Name
javax.management.InvalidAttributeValueException
UpdateException
ObjectActiveException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |