com.cyclonecommerce.cybervan.api
Interface ConfigurationApi

All Known Implementing Classes:

ConfigurationApiStub

public interface ConfigurationApi

This interface defines the Configuration API The basic purpose of this interface is to provide a means to retrieve, add, modify, or remove company and partner profiles from an instance of Interchange.

Each company is identified by a unique identifier, the company id, which is unique within a server. A client can use the findCompanies message to lookup the company ids. The client can then use these ids to get information about a company (getCompanyProfiles), modify information for a company (setCompanyProfiles), or remove a company (removeCompany). The client can also add a new company to the server using the same setCompanyProfiles. A company’s data is represented in an XML document.
Each partner is identified by a unique identifier, the partner id, which is unique within a server. A client can use the findPartners message to lookup the partner ids. The client can then use these ids to get information about a partner (getPartnerProfiles), modify information for a partner (setPartnerProfiles), or remove a partner (removePartner). The client can also add a new partner to the server using the same setPartnerData. A partner’s data is represented in an XML document.

Method Summary

org.w3c.dom.Element	findCompanies(org.w3c.dom.Element companyQuery) This message returns all the company ids that match the given criteria, which can then be passed to one of the other messages requiring a company id. In the event that a large number of company ids may be returned, the client or the server can specify a maximum limit.
org.w3c.dom.Element	findPartners(org.w3c.dom.Element partnerQuery) This message returns all the partner ids that match the given criteria, which can then be passed to one of the other messages requiring a partner id. In the event that a large number of partner ids may be returned, the client or the server can specify a maximum limit.
org.w3c.dom.Element	getCompanyProfiles(org.w3c.dom.Element companyIdList, java.lang.String formatName) This message returns the company data for each of the specified companies in the Interchange Company Config XML format.
org.w3c.dom.Element	getCompanyProfiles(org.w3c.dom.Element companyIdList, java.lang.String formatName, java.lang.String certPassword) This message returns the company data for each of the specified companies in the Interchange Company Config XML format.
org.w3c.dom.Element	getPartnerProfiles(org.w3c.dom.Element partnerIdList, java.lang.String formatName) This message returns the partner data for each of the specified partners in the Interchange Partner Config XML format.
org.w3c.dom.Element	removeCompanies(org.w3c.dom.Element companyIdList) This message removes the given companies from the Interchange Server.
org.w3c.dom.Element	removePartners(org.w3c.dom.Element partnerIdList) This message removes the given partners from the Interchange Server.
org.w3c.dom.Element	setCompanyProfiles(org.w3c.dom.Element companyData) This message allows the client to add new companies or modify the data of existing companies.
org.w3c.dom.Element	setCompanyProfiles(org.w3c.dom.Element companyData, java.lang.String certPassword) This message allows the client to add new companies or modify the data of existing companies.
org.w3c.dom.Element	setPartnerProfiles(org.w3c.dom.Element partnerData) This message allows the client to add new partners or modify the data of existing partners.

Method Detail

findCompanies

public org.w3c.dom.Element findCompanies(org.w3c.dom.Element companyQuery)
                                  throws com.cyclonecommerce.idk.authentication.AuthenticationException,
                                         com.cyclonecommerce.idk.api.InvalidQueryException,
                                         com.cyclonecommerce.idk.api.ServerException

This message returns all the company ids that match the given criteria, which can then be passed to one of the other messages requiring a company id.
In the event that a large number of company ids may be returned, the client or the server can specify a maximum limit. The client specifies the limit by supplying the MaxOrgs attribute. The server can also have an internal limit, which means that the result may be less than the client expected. In the event that there are more company ids to return after an initial call, the server will return a Cursor, where the value has meaning only to the server. This Cursor can be passed to a subsequent call to get the next set, which may in turn have only a subset of the remaining items, in which case the same scenario exists again. When called with a Cursor, the only other parameter that will be used by the server is MaxOrgs, and all others will be ignored.

Parameters:

companyQuery - The query used for the search. The XML is an CompanyQuery element as defined in InterchangeConfigAPI.xsd.

Returns:

all the company ids that match the query in the form of a QueryResult Element as defined in ProfileManagementAPI.xsd. In the event that more company ids match the query than can be returned in a single call, the result will also contain a Cursor Element.

Throws:

com.cyclonecommerce.idk.authentication.AuthenticationException - The client has not been authorized to make this call or the session has timed out.

com.cyclonecommerce.idk.api.InvalidQueryException - The query does not conform to the proper XML format, contains an invalid Cursor, or contains query elements that are invalid.

com.cyclonecommerce.idk.api.ServerException - Some unexpected error occurred on the server.

getCompanyProfiles

public org.w3c.dom.Element getCompanyProfiles(org.w3c.dom.Element companyIdList,
                                              java.lang.String formatName)
                                       throws com.cyclonecommerce.idk.authentication.AuthenticationException,
                                              com.cyclonecommerce.idk.api.InvalidFormatException,
                                              com.cyclonecommerce.idk.api.ServerException

This message returns the company data for each of the specified companies in the Interchange Company Config XML format.

Parameters:

companyIdList - Specifies the company identifiers whose data should be returned.

formatName - Speficies the format the requested companies' data should be returned in. If the parameter is not included, the server uses its native format. The server may place restrictions on which formats a particular client has access to.

Returns:

This message returns an XML document conforming to the Interchange Company Config XML fomat. Each company's XML will be contained within the CompanyOutputList.

If a companyId is invalid, the returned XML for that company will contain a Disposition element.

The server may limit the number of requested companies thus returning less than the client requested. The elements will be absent in the returned document and the client will have to make an additional call to retrieve them.

Throws:

com.cyclonecommerce.idk.authentication.AuthenticationException - The client has not been authorized to make this call or the session has timed out.

com.cyclonecommerce.idk.api.InvalidFormatException - The given formatName is unknown or the client does not have access to it.

com.cyclonecommerce.idk.api.ServerException - Some unexpected error occurred on the server.

getCompanyProfiles

public org.w3c.dom.Element getCompanyProfiles(org.w3c.dom.Element companyIdList,
                                              java.lang.String formatName,
                                              java.lang.String certPassword)
                                       throws com.cyclonecommerce.idk.authentication.AuthenticationException,
                                              com.cyclonecommerce.idk.api.InvalidFormatException,
                                              com.cyclonecommerce.idk.api.ServerException

This message returns the company data for each of the specified companies in the Interchange Company Config XML format.

Parameters:

companyIdList - Specifies the company identifiers whose data should be returned.

formatName - Specifies the format the requested companies' data should be returned in. If the parameter is not included, the server uses its native format. The server may place restrictions on which formats a particular client has access to.

certPassword - Specifies the password used to encrypt the PKCS#12 certificates associated with the company profiles.

Returns:

This message returns an XML document conforming to the Interchange Company Config XML fomat. Each company's XML will be contained within the CompanyOutputList.

If a companyId is invalid, the returned XML for that company will contain a Disposition element.

The server may limit the number of requested companies thus returning less than the client requested. The elements will be absent in the returned document and the client will have to make an additional call to retrieve them.

Throws:

com.cyclonecommerce.idk.authentication.AuthenticationException - The client has not been authorized to make this call or the session has timed out.

com.cyclonecommerce.idk.api.InvalidFormatException - The given formatName is unknown or the client does not have access to it.

com.cyclonecommerce.idk.api.ServerException - Some unexpected error occurred on the server.

setCompanyProfiles

public org.w3c.dom.Element setCompanyProfiles(org.w3c.dom.Element companyData)
                                       throws com.cyclonecommerce.idk.authentication.AuthenticationException,
                                              com.cyclonecommerce.idk.api.InvalidFormatException,
                                              com.cyclonecommerce.idk.api.ServerException

This message allows the client to add new companies or modify the data of existing companies. New comapnies are added by specifying a Company Id not previously known to the Interchange Server.

Parameters:

companyData - Specifies everything about the companies to be added and modified. The companyData must be formatted in the Interchange Company Config XML format.

Returns:

A CompanyDataOutputList as described in the InterchangeCompanyConfig.xsd. For each set of company data passed as input, there is a corresponding output. The output either indicates the creation or update was successful, including the company id or that the input for the company was invalid.

Throws:

com.cyclonecommerce.idk.authentication.AuthenticationException - The client has not been authorized to make this call or the session has timed out.

com.cyclonecommerce.idk.api.InvalidFormatException - The given companies XML format is unknown to the server.

com.cyclonecommerce.idk.api.ServerException - Some unexpected error occurred on the server.

setCompanyProfiles

public org.w3c.dom.Element setCompanyProfiles(org.w3c.dom.Element companyData,
                                              java.lang.String certPassword)
                                       throws com.cyclonecommerce.idk.authentication.AuthenticationException,
                                              com.cyclonecommerce.idk.api.InvalidFormatException,
                                              com.cyclonecommerce.idk.api.ServerException

This message allows the client to add new companies or modify the data of existing companies. New comapnies are added by specifying a Company Id not previously known to the Interchange Server.

Parameters:

companyData - Specifies everything about the companies to be added and modified. The companyData must be formatted in the Interchange Company Config XML format.

certPassword - Specifies the PKCS#12 certificate password used to encrypt the certificates associtated with the company profiles.

Returns:

A CompanyDataOutputList as described in the InterchangeCompanyConfig.xsd. For each set of company data passed as input, there is a corresponding output. The output either indicates the creation or update was successful, including the company id or that the input for the company was invalid.

Throws:

com.cyclonecommerce.idk.authentication.AuthenticationException - The client has not been authorized to make this call or the session has timed out.

com.cyclonecommerce.idk.api.InvalidFormatException - The given companies XML format is unknown to the server.

com.cyclonecommerce.idk.api.ServerException - Some unexpected error occurred on the server.

removeCompanies

public org.w3c.dom.Element removeCompanies(org.w3c.dom.Element companyIdList)
                                    throws com.cyclonecommerce.idk.authentication.AuthenticationException,
                                           com.cyclonecommerce.idk.api.InvalidFormatException,
                                           com.cyclonecommerce.idk.api.ServerException

This message removes the given companies from the Interchange Server.

Parameters:

companyIdList - Specifies companies that should be removed from the server.

Returns:

An CompanyDataOutputList as described in the InterchangeCompanyConfig.xsd. For each company id passed as input, there is a corresponding output containing a Disposition element, which indicates the removal was successful or not.

Throws:

com.cyclonecommerce.idk.authentication.AuthenticationException - The client has not been authorized to make this call or the session has timed out.

com.cyclonecommerce.idk.api.ServerException - Some unexpected error occurred on the server.

findPartners

public org.w3c.dom.Element findPartners(org.w3c.dom.Element partnerQuery)
                                 throws com.cyclonecommerce.idk.authentication.AuthenticationException,
                                        com.cyclonecommerce.idk.api.InvalidQueryException,
                                        com.cyclonecommerce.idk.api.ServerException

This message returns all the partner ids that match the given criteria, which can then be passed to one of the other messages requiring a partner id.
In the event that a large number of partner ids may be returned, the client or the server can specify a maximum limit. The client specifies the limit by supplying the MaxOrgs attribute. The server can also have an internal limit, which means that the result may be less than the client expected. In the event that there are more partner ids to return after an initial call, the server will return a Cursor, where the value has meaning only to the server. This Cursor can be passed to a subsequent call to get the next set, which may in turn have only a subset of the remaining items, in which case the same scenario exists again. When called with a Cursor, the only other parameter that will be used by the server is MaxOrgs, and all others will be ignored.

Parameters:

partnerQuery - The query used for the search. The XML is an PartnerQuery element as defined in the InterchangePartnerConfig.xsd.

Returns:

all the partner ids that match the query in the form of a QueryResult Element as defined in the ProfileManagementApi.xsd. In the event that more partner ids match the query than can be returned in a single call, the result will also contain a Cursor Element.

Throws:

com.cyclonecommerce.idk.authentication.AuthenticationException - The client has not been authorized to make this call or the session has timed out.

com.cyclonecommerce.idk.api.InvalidQueryException - The query does not conform to the proper XML format, contains an invalid Cursor, or contains query elements that are invalid.

com.cyclonecommerce.idk.api.ServerException - Some unexpected error occurred on the server.

getPartnerProfiles

public org.w3c.dom.Element getPartnerProfiles(org.w3c.dom.Element partnerIdList,
                                              java.lang.String formatName)
                                       throws com.cyclonecommerce.idk.authentication.AuthenticationException,
                                              com.cyclonecommerce.idk.api.InvalidFormatException,
                                              com.cyclonecommerce.idk.api.ServerException

This message returns the partner data for each of the specified partners in the Interchange Partner Config XML format.

Parameters:

partnerIdList - Specifies the partner identifiers whose data should be returned.

formatName - Speficies the format the requested partners' data should be returned in. If the parameter is not included, the server uses its native format. The server may place restrictions on which formats a particular client has access to.

Returns:

This message returns an XML document conforming to the Interchange Partner Config XML fomat. Each partner's XML will be contained within the PartnerOutputList.

If a partnerId is invalid, the returned XML for that partner will contain a Disposition element.

The server may limit the number of requested partners thus returning less than the client requested. The elements will be absent in the returned document and the client will have to make an additional call to retrieve them.

Throws:

com.cyclonecommerce.idk.authentication.AuthenticationException - The client has not been authorized to make this call or the session has timed out.

com.cyclonecommerce.idk.api.InvalidFormatException - The given formatName is unknown or the client does not have access to it.

com.cyclonecommerce.idk.api.ServerException - Some unexpected error occurred on the server.

setPartnerProfiles

public org.w3c.dom.Element setPartnerProfiles(org.w3c.dom.Element partnerData)
                                       throws com.cyclonecommerce.idk.authentication.AuthenticationException,
                                              com.cyclonecommerce.idk.api.InvalidFormatException,
                                              com.cyclonecommerce.idk.api.ServerException

This message allows the client to add new partners or modify the data of existing partners. New partners are added by specifying a partner Id not previously known to the Interchange Server.

Parameters:

partnerData - Specifies everything about the partner to be added and modified. The partnerData must be formatted in the Interchange Partner Config XML format.

Returns:

A PartnerDataOutputList as described in the InterchangePartnerConfig.xsd. For each set of partner data passed as input, there is a corresponding output. The output either indicates the creation or update was successful, including the partner id or that the input for the partner was invalid.

Throws:

com.cyclonecommerce.idk.authentication.AuthenticationException - The client has not been authorized to make this call or the session has timed out.

com.cyclonecommerce.idk.api.InvalidFormatException - The given partners XML format is unknown to the server.

com.cyclonecommerce.idk.api.ServerException - Some unexpected error occurred on the server.

removePartners

public org.w3c.dom.Element removePartners(org.w3c.dom.Element partnerIdList)
                                   throws com.cyclonecommerce.idk.authentication.AuthenticationException,
                                          com.cyclonecommerce.idk.api.InvalidFormatException,
                                          com.cyclonecommerce.idk.api.ServerException

This message removes the given partners from the Interchange Server.

Parameters:

partnerIdList - Specifies partners that should be removed from the server.

Returns:

An PartnerDataOutputList as described in the InterchangePartnerConfig.xsd. For each partner id passed as input, there is a corresponding output containing a Disposition element, which indicates the removal was successful or not.

Throws:

com.cyclonecommerce.idk.authentication.AuthenticationException - The client has not been authorized to make this call or the session has timed out.

com.cyclonecommerce.idk.api.ServerException - Some unexpected error occurred on the server.