public interface IParticipants
Modifier and Type | Method and Description |
---|---|
void |
createCertificateCredential(java.lang.String participantName,
java.lang.String alias,
java.lang.String fileName,
java.lang.String fileContent)
Upload a new certificate key for a given participant.
|
void |
createParticipant(java.lang.String name,
boolean isActive,
boolean isHost)
Create a new participant as a host or partner with the given name, and activate it or not.
|
void |
createParticipantBusinessLocation(java.lang.String participantName,
com.tibco.ax.fw.cfg.api.Location location)
Create a business location for a participant.
|
void |
createParticipantBusinessLocationContact(java.lang.String participantName,
java.lang.String locationName,
Contact contact)
Create a contact associated with a business location of a participant.
|
void |
createPgpKeyPair(java.lang.String participantName,
java.lang.String alias,
int keyType,
java.lang.String realName,
java.lang.String email,
java.util.Date expiryDate,
java.lang.String password,
int keySize)
Generate a new PGP key pair for a given participant.
|
void |
createPgpPrivateKeyCredential(java.lang.String participantName,
java.lang.String alias,
java.lang.String fileName,
java.lang.String fileContent,
java.lang.String ascii,
java.lang.String asciiPubForPrv,
java.lang.String password,
boolean isPGPNewAscii)
Upload a new PGP private key for a given participant.
|
void |
createPgpPublicKeyCredential(java.lang.String participantName,
java.lang.String alias,
java.lang.String fileName,
java.lang.String fileContent,
java.lang.String ascii,
boolean isPGPNewAscii)
Upload a new PGP public key for a given participant.
|
void |
createPrivateKeyCredential(java.lang.String participantName,
java.lang.String alias,
java.lang.String fileName,
java.lang.String fileContent,
java.lang.String password)
Upload a new private key for a given participant.
|
void |
createSshPrivateKeyCredential(java.lang.String participantName,
java.lang.String alias,
java.lang.String fileName,
java.lang.String fileContent,
java.lang.String password)
Upload a new SSH private key for a given participant.
|
void |
createSshPublicKeyCredential(java.lang.String participantName,
java.lang.String alias,
java.lang.String fileName,
java.lang.String fileContent)
Upload a new SSH public key for a given participant.
|
void |
createTransport(java.lang.String participantName,
java.lang.String protocolName,
java.lang.String transportName,
java.lang.String transportType)
Add a transport to an enabled protocol for a given participant.
|
void |
deleteAllCredentials(java.lang.String participantName)
Delete all credentials for a given participant.
|
void |
deleteCredential(java.lang.String participantName,
java.lang.String alias)
Delete credential for a given participant.
|
void |
deleteParticipant(java.lang.String name)
Delete a participant.
|
void |
deleteParticipantBusinessLocation(java.lang.String participantName,
java.lang.String locationName)
Delete the business location of participant.
|
void |
deleteParticipantBusinessLocationContact(java.lang.String participantName,
java.lang.String locationName,
java.lang.String firstName,
java.lang.String lastName)
Delete a contact associated with a business location of a participant.
|
void |
deleteTransports(java.lang.String participantName,
java.lang.String protocolName,
java.lang.String[] transportNames)
Delete given transports from a given protocol for a given participant.
|
java.util.List |
retrieveAllCredentials(java.lang.String participantName)
Retrieve all credentials for a given participant.
|
java.util.List |
retrieveAllTransports(java.lang.String participantName,
java.lang.String protocolName)
Retrieve all transports of a given protocol for a given participant.
|
java.util.List |
retrieveAvailableShadows(java.lang.String participantName,
java.lang.String alias,
java.lang.String credType)
Retrieve available shadows for a given certificate or private key.
|
Credential |
retrieveCertificateCredential(java.lang.String participantName,
java.lang.String alias,
java.lang.String format)
Export certificate from a given participant.
|
java.lang.Object[] |
retrieveEnabledProtocolPropertyValues(java.lang.String participantName,
java.lang.String protocol,
java.lang.String[] names)
Retrieve property values from an enabled protocol of a given participant.
|
java.util.List |
retrieveHostPropertyDefinitions(java.lang.String protocol)
Retrieve all the available host property definitions for a given protocol.
|
com.tibco.ax.fw.cfg.api.Location |
retrieveParticipantBusinessLocation(java.lang.String participantName,
java.lang.String locationName)
Retrieve the business location of participant.
|
Contact[] |
retrieveParticipantBusinessLocationContacts(java.lang.String participantName,
java.lang.String locationName)
Retrieve contacts associated with a business location of a participant.
|
java.util.List |
retrievePartnerPropertyDefinitions(java.lang.String protocol)
Retrieve all the available partner property definitions for a given protocol.
|
Credential |
retrievePgpPrivateKeyCredential(java.lang.String participantName,
java.lang.String alias,
boolean isPGPAscii)
Export PGP private key from a given participant.
|
Credential |
retrievePgpPublicKeyCredential(java.lang.String participantName,
java.lang.String alias,
boolean isPGPAscii)
Export PGP public key from a given participant.
|
Credential |
retrievePrivateKeyCredential(java.lang.String participantName,
java.lang.String alias,
java.lang.String format)
Export private key from a given participant.
|
Credential |
retrieveSshPrivateKeyCredential(java.lang.String participantName,
java.lang.String alias)
Export SSH private key from a given participant.
|
Credential |
retrieveSshPublicKeyCredential(java.lang.String participantName,
java.lang.String alias,
boolean sshcom)
Export SSH public key from a given participant.
|
java.lang.Object[] |
retrieveTransportPropertyValues(java.lang.String participantName,
java.lang.String protocolName,
java.lang.String transportName,
java.lang.String[] names)
Retrieve transport property of a given protocol for a given participant.
|
java.util.List |
retrieveTransportTypes(java.lang.String participantName,
java.lang.String protocolName)
Retrieve available transport types of a given protocol for a given participant.
|
void |
updateCertificateCredential(java.lang.String participantName,
java.lang.String alias,
java.lang.String fileName,
java.lang.String fileContent,
java.lang.String newAlias,
java.lang.String shadowCertName,
java.util.Date getby)
Update a uploaded certificate key for a given participant.
|
void |
updateDisabledParticipantProtocols(java.lang.String participantName,
java.lang.String[] protocols)
Enable given protocols for a participant.
|
void |
updateEnabledParticipantProtocols(java.lang.String participantName,
java.lang.String[] protocols)
Disable given protocols for a participant.
|
void |
updateEnabledProtocolPropertyValues(java.lang.String participantName,
java.lang.String protocol,
java.lang.String[] names,
java.lang.Object[] values)
Set property values of an enabled protocol for a given participant.
|
void |
updateParticipantBusinessLocationLegalContact(java.lang.String participantName,
java.lang.String locationName,
java.lang.String firstName,
java.lang.String lastName)
Set a primary legal contact associated with a business location of a participant.
|
void |
updateParticipantBusinessLocationSupportContact(java.lang.String participantName,
java.lang.String locationName,
java.lang.String firstName,
java.lang.String lastName)
Set a primary support contact associated with a business location of a participant.
|
void |
updatePrivateKeyCredential(java.lang.String participantName,
java.lang.String alias,
java.lang.String fileName,
java.lang.String fileContent,
java.lang.String newAlias,
java.lang.String shadowCertName,
java.util.Date getby,
java.lang.String password)
Update a uploaded private key for a given participant.
|
void |
updateSshPrivateKeyCredential(java.lang.String participantName,
java.lang.String alias,
java.lang.String fileName,
java.lang.String fileContent,
java.lang.String newAlias,
java.lang.String password)
Update a uploaded SSH private key for a given participant.
|
void |
updateSshPublicKeyCredential(java.lang.String participantName,
java.lang.String alias,
java.lang.String fileName,
java.lang.String fileContent,
java.lang.String newAlias)
Update an uploaded SSH public key for a given participant.
|
void |
updateTransportPropertyValues(java.lang.String participantName,
java.lang.String protocolName,
java.lang.String transportName,
java.lang.String[] names,
java.lang.Object[] values)
Set transport property values of a given protocol for a given participant.
|
void createParticipant(java.lang.String name, boolean isActive, boolean isHost)
name
- the name of the new created participant.isActive
- set to true if activating the new created participant, otherwise set to false.isHost
- set to true if the participant is a host, otherwise set to false.void deleteParticipant(java.lang.String name)
name
- the name of participant to be deleted.void createParticipantBusinessLocation(java.lang.String participantName, com.tibco.ax.fw.cfg.api.Location location) throws ConfigException
participantName
- the name of a participant.location
- the business location of a participant.ConfigException
com.tibco.ax.fw.cfg.api.Location retrieveParticipantBusinessLocation(java.lang.String participantName, java.lang.String locationName) throws ConfigException
participantName
- the name of a participant.locationName
- business location name of a participant.ConfigException
void deleteParticipantBusinessLocation(java.lang.String participantName, java.lang.String locationName) throws ConfigException
participantName
- the name of a participant.locationName
- business location name of a participant.ConfigException
void createParticipantBusinessLocationContact(java.lang.String participantName, java.lang.String locationName, Contact contact) throws ConfigException
participantName
- the name of a participant.locationName
- the business location name of a participant.contact
- the contact associated with the business location of the participant.ConfigException
Contact[] retrieveParticipantBusinessLocationContacts(java.lang.String participantName, java.lang.String locationName) throws ConfigException
participantName
- the name of a participant.locationName
- business location name of a participant.ConfigException
void deleteParticipantBusinessLocationContact(java.lang.String participantName, java.lang.String locationName, java.lang.String firstName, java.lang.String lastName) throws ConfigException
participantName
- the name of a participant.locationName
- business location name of a participant.firstName
- the firstName of the contact.lastName
- the lastName of the contact.ConfigException
void updateParticipantBusinessLocationSupportContact(java.lang.String participantName, java.lang.String locationName, java.lang.String firstName, java.lang.String lastName) throws ConfigException
participantName
- the name of a participant.locationName
- business location name of a participant.firstName
- the firstName of the primary support contact.lastName
- the lastName of the primary support contact.ConfigException
void updateParticipantBusinessLocationLegalContact(java.lang.String participantName, java.lang.String locationName, java.lang.String firstName, java.lang.String lastName) throws ConfigException
participantName
- the name of a participant.locationName
- business location name of a participant.firstName
- the firstName of the primary legal contact.lastName
- the lastName of the primary legal contact.ConfigException
void updateDisabledParticipantProtocols(java.lang.String participantName, java.lang.String[] protocols) throws ConfigException
participantName
- the name of a participant.protocols
- names of protocols to be enabled.ConfigException
void updateEnabledParticipantProtocols(java.lang.String participantName, java.lang.String[] protocols) throws ConfigException
participantName
- the name of a participant.protocols
- the names of protocols to be disabled.ConfigException
void updateEnabledProtocolPropertyValues(java.lang.String participantName, java.lang.String protocol, java.lang.String[] names, java.lang.Object[] values) throws ConfigException
participantName
- the name of a participant.protocol
- the name of the protocol.names
- the names of protocol properties.Please refer to the related user guide documentation for all the supported property names of the specified protocol.values
- the values of protocol properties.ConfigException
java.lang.Object[] retrieveEnabledProtocolPropertyValues(java.lang.String participantName, java.lang.String protocol, java.lang.String[] names) throws ConfigException
participantName
- the name of a participant.protocol
- the name of the protocol.names
- an array of protocol property names.Please refer to the related user guide documentation for all the supported property names of the specified protocol.ConfigException
java.util.List retrievePartnerPropertyDefinitions(java.lang.String protocol) throws ConfigException
protocol
- the name of the protocol.ConfigException
java.util.List retrieveHostPropertyDefinitions(java.lang.String protocol) throws ConfigException
protocol
- the name of the protocol.ConfigException
void createCertificateCredential(java.lang.String participantName, java.lang.String alias, java.lang.String fileName, java.lang.String fileContent) throws ConfigException
participantName
- the name of a participant.alias
- alias of the uploaded certificate key.fileName
- the file name of the uploaded certificate key.fileContent
- the content of certificate key encoded with Base64.ConfigException
void createSshPublicKeyCredential(java.lang.String participantName, java.lang.String alias, java.lang.String fileName, java.lang.String fileContent) throws ConfigException
participantName
- the name of a participant.alias
- alias of the uploaded SSH public key.fileName
- the file name of the uploaded SSH public key.fileContent
- the content of SSH public key encoded with Base64.ConfigException
void createPgpPublicKeyCredential(java.lang.String participantName, java.lang.String alias, java.lang.String fileName, java.lang.String fileContent, java.lang.String ascii, boolean isPGPNewAscii) throws ConfigException
participantName
- the name of a participant.alias
- alias of the uploaded PGP public key.fileName
- the file name of the uploaded PGP public key.Pass null when encoding with ASCII Armor.fileContent
- the content of PGP public key encoded with Base64.Pass null when encoding with ASCII Armor.ascii
- the content of PGP public key encoded with ASCII Armor.Pass null when encoding with Base64.isPGPNewAscii
- true if encoding the PGP public key into ASCII Armor, false if encoding the PGP public key into Base64.ConfigException
void createPrivateKeyCredential(java.lang.String participantName, java.lang.String alias, java.lang.String fileName, java.lang.String fileContent, java.lang.String password) throws ConfigException
participantName
- the name of a participant.alias
- alias of the uploaded private key.fileName
- file name of the uploaded private key.fileContent
- content of private key encoded with Base64.password
- password of the uploaded private key.ConfigException
void createSshPrivateKeyCredential(java.lang.String participantName, java.lang.String alias, java.lang.String fileName, java.lang.String fileContent, java.lang.String password) throws ConfigException
participantName
- the name of a participant.alias
- alias of the uploaded SSH private key.fileName
- file name of the uploaded SSH private key.fileContent
- content of SSH private key encoded with Base64.password
- password of the uploaded SSH private key.ConfigException
void createPgpPrivateKeyCredential(java.lang.String participantName, java.lang.String alias, java.lang.String fileName, java.lang.String fileContent, java.lang.String ascii, java.lang.String asciiPubForPrv, java.lang.String password, boolean isPGPNewAscii) throws ConfigException
participantName
- the name of a participant.alias
- alias of the uploaded PGP private key.fileName
- file name of the uploaded PGP private key.Pass null when encoding with ASCII Armor.fileContent
- content of PGP private key encoded with Base64.Pass null when encoding with ASCII Armor.ascii
- content of PGP private key encoded with ASCII Armor.Pass null when encoding with Base64.asciiPubForPrv
- content of PGP public key associated with PGP private key encoded with ASCII Armor.password
- password of the uploaded PGP private key.isPGPNewAscii
- true if encoding the PGP private key into ASCII Armor, false if encoding the PGP private key into Base64.ConfigException
void createPgpKeyPair(java.lang.String participantName, java.lang.String alias, int keyType, java.lang.String realName, java.lang.String email, java.util.Date expiryDate, java.lang.String password, int keySize) throws ConfigException
participantName
- the name of a participant.alias
- alias of the generated PGP private key.keyType
- 0 for DSA_EL_GAMAL key, 1 for RSA_RSA key.realName
- the full name of the person for whom the key is being created.email
- the email address associated with the real name.expiryDate
- the date on which the key expires or null if key never expires.password
- password of the generated PGP private key.keySize
- 1024 or 2048.ConfigException
void updateCertificateCredential(java.lang.String participantName, java.lang.String alias, java.lang.String fileName, java.lang.String fileContent, java.lang.String newAlias, java.lang.String shadowCertName, java.util.Date getby) throws ConfigException
participantName
- the name of a participant.alias
- alias of the uploaded certificate key.fileName
- file name of the uploaded certificate key.fileContent
- content of certificate key encoded with Base64.newAlias
- new alias for the updated certificate key.shadowCertName
- shadow certificate name of the updated certificate.The shadow certificate should be another uploaded certificate key.getby
- activation date for shadow certificate.ConfigException
void updateSshPublicKeyCredential(java.lang.String participantName, java.lang.String alias, java.lang.String fileName, java.lang.String fileContent, java.lang.String newAlias) throws ConfigException
participantName
- the name of a participant.alias
- alias of the uploaded SSH public key.fileName
- file name of the uploaded SSH public key.fileContent
- content of SSH public key encoded with Base64.newAlias
- new alias for the updated SSH public key.ConfigException
void updatePrivateKeyCredential(java.lang.String participantName, java.lang.String alias, java.lang.String fileName, java.lang.String fileContent, java.lang.String newAlias, java.lang.String shadowCertName, java.util.Date getby, java.lang.String password) throws ConfigException
participantName
- the name of a participant.alias
- alias of the uploaded private key.fileName
- file name of the uploaded private key.fileContent
- content of private key encoded with Base64.newAlias
- new alias for the updated private key.shadowCertName
- shadow key name of the updated private key.The shadow key should be another uploaded private key.getby
- activation date for shadow key.password
- new password for the updated private key.ConfigException
void updateSshPrivateKeyCredential(java.lang.String participantName, java.lang.String alias, java.lang.String fileName, java.lang.String fileContent, java.lang.String newAlias, java.lang.String password) throws ConfigException
participantName
- the name of a participant.alias
- alias of the uploaded SSH private key.fileName
- file name of the uploaded SSH private key.fileContent
- content of SSH private key encoded with Base64.newAlias
- new alias for the updated SSH private key.password
- new password for the updated SSH private key.ConfigException
java.util.List retrieveAllCredentials(java.lang.String participantName) throws ConfigException
participantName
- the name of a participant.ConfigException
Credential retrieveCertificateCredential(java.lang.String participantName, java.lang.String alias, java.lang.String format) throws ConfigException
participantName
- the name of a participant.alias
- alias of exported certificate.format
- the export format.Options:DER_ENCODED_BINARY_X_509, BASE64_ENCODED_X_509, PKCS7, PKCS7_WITH_ALL_CERTS_IN_PATH, PKCS12,PKCS12_WITH_ALL_CERTS_IN_PATHConfigException
Credential retrieveSshPublicKeyCredential(java.lang.String participantName, java.lang.String alias, boolean sshcom) throws ConfigException
participantName
- the name of a participant.alias
- alias of exported SSH public key.sshcom
- if true encoded with ASCII Armour,otherwise with Base64.ConfigException
Credential retrievePgpPublicKeyCredential(java.lang.String participantName, java.lang.String alias, boolean isPGPAscii) throws ConfigException
participantName
- the name of a participant.alias
- alias of exported PGP public key.isPGPAscii
- is true if content of retrieved PGP public key encoded with ASCII Armor,otherwise with Base64.ConfigException
Credential retrievePrivateKeyCredential(java.lang.String participantName, java.lang.String alias, java.lang.String format) throws ConfigException
participantName
- the name of a participant.alias
- alias of exported private key.format
- the export format.Options: DER_ENCODED_BINARY_X_509,BASE64_ENCODED_X_509,PKCS7,PKCS7_WITH_ALL_CERTS_IN_PATH,PKCS12,PKCS12_WITH_ALL_CERTS_IN_PATHConfigException
Credential retrieveSshPrivateKeyCredential(java.lang.String participantName, java.lang.String alias) throws ConfigException
participantName
- the name of a participant.alias
- alias of exported SSH private key.ConfigException
Credential retrievePgpPrivateKeyCredential(java.lang.String participantName, java.lang.String alias, boolean isPGPAscii) throws ConfigException
participantName
- the name of a participant.alias
- alias of exported PGP private key.isPGPAscii
- is true if content of retrieved PGP private key encoded with ASCII Armor,otherwise with Base64.ConfigException
java.util.List retrieveAvailableShadows(java.lang.String participantName, java.lang.String alias, java.lang.String credType) throws ConfigException
participantName
- the name of a participant.alias
- alias of certificate or private key.credType
- type of shadows.Options:CCRED,KCRED.ConfigException
void deleteCredential(java.lang.String participantName, java.lang.String alias) throws ConfigException
participantName
- the name of a participant.alias
- alias of credential to be deleted.ConfigException
void deleteAllCredentials(java.lang.String participantName) throws ConfigException
participantName
- the name of a participant.ConfigException
void createTransport(java.lang.String participantName, java.lang.String protocolName, java.lang.String transportName, java.lang.String transportType) throws ConfigException
participantName
- the name of a participant.protocolName
- the name of protocol.transportName
- the name of transport.transportType
- the type transport.Options:AS1_EMAIL,AS2_HTTP,AS2_HTTPS,MFT_EXTERNAL,AS3_FTP,AS3_FTPS,FILE,FTP,FTPS,FTPD,FTPSD,SFTPD,SSHFTP,SMTP,HTTP,HTTPS,HTTPSCA,SFWS,INBOX,JMS,TIBRV,CFI,CFIWIN,CFIUNIX,CFIZOS,CFII5,EBICS,TRUSTACTConfigException
void deleteTransports(java.lang.String participantName, java.lang.String protocolName, java.lang.String[] transportNames) throws ConfigException
participantName
- the name of a participant.protocolName
- the name of protocol.transportNames
- names of transport to be deleted.ConfigException
void updateTransportPropertyValues(java.lang.String participantName, java.lang.String protocolName, java.lang.String transportName, java.lang.String[] names, java.lang.Object[] values) throws ConfigException
participantName
- the name of a participant.protocolName
- the name of protocol.transportName
- the name of transport.names
- array of transport property names.Please refer to the related user guide documentation for the list of all available property names.values
- array of transport property values.ConfigException
java.lang.Object[] retrieveTransportPropertyValues(java.lang.String participantName, java.lang.String protocolName, java.lang.String transportName, java.lang.String[] names) throws ConfigException
participantName
- the name of a participant.protocolName
- the name of protocol.transportName
- the name of transport.names
- array of transport property names.Please refer to the related user guide documentation for the list of all available property names.ConfigException
java.util.List retrieveTransportTypes(java.lang.String participantName, java.lang.String protocolName) throws ConfigException
participantName
- the name of a participant.protocolName
- the name of protocol.ConfigException
java.util.List retrieveAllTransports(java.lang.String participantName, java.lang.String protocolName) throws ConfigException
participantName
- the name of a participant.protocolName
- the name of protocol.ConfigException