|
Oracle Communications Services Gatekeeper OAM Java API Reference 6.0 E55516-02 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Method Summary | |
int |
countApplicationGroupsByType(String slaType) Counts the application groups for a particular SLA type that have a service level agreement defined. |
int |
countApplicationGroupSlaTypes(String applicationGroupIdentifier) Counts the system level and custom SLA types defined for an application group. |
int |
countApplicationSlaGroups() Counts number of application Service Level Agreements. |
int |
countCustomSlaXSDDefinition() Counts the number of custom Service Level Agreements. |
int |
countGlobalSlaTypes() Count the system level and custom SLA types defined for a global scope. |
int |
countServiceProviderGroupsByType(String slaType) Counts the service providers with a service level agreement defined of type. |
int |
countServiceProviderGroupSlaTypes(String serviceProviderGroupIdentifier) Counts the system level and custom SLA types defined for a service provider group |
int |
countServiceProviderSlaGroups() Counts the number of service provider Service Level Agreements. |
String[] |
listApplicationGroupsByType(String slaType, int offset, int size) Lists the application groups for a particular SLA type that have a service level agreement defined. |
String[] |
listApplicationGroupSlaTypes(String applicationGroupIdentifier, int offset, int size) Lists the system level and custom SLA types defined for an application group. |
String[] |
listApplicationSlaGroups(int offset, int size) Lists application groups with attached Service Level Agreements. |
String[] |
listCustomSlaXSDDefinition(int offset, int size) Lists the custom XSD types |
String[] |
listGlobalSlaTypes(int offset, int size) Lists the system level and custom SLA types defined for a global scope |
String[] |
listServiceProviderGroupsByType(String slaType, int offset, int size) Lists the service provider groups with a service level agreement defined of type The following system level SLA types are valid for service provider groups: service_provider - Service provider group SLA stored and enforced only on the local site. |
String[] |
listServiceProviderGroupSlaTypes(String serviceProviderGroupIdentifier, int offset, int size) Lists the system level and custom SLA types defined for a service provider. |
String[] |
listServiceProviderSlaGroups(int offset, int size) Lists service provider groups with attached Service Level Agreements. |
void |
loadApplicationGroupSla(String applicationGroupIdentifier, String fileContent) Loads the provided application group SLA. |
void |
loadApplicationGroupSlaByType(String slaType, String applicationGroupIdentifier, String fileContent) Loads a system level or custom SLA for an application group. |
void |
loadApplicationGroupSlaFromUrl(String applicationGroupIdentifier, String serviceLevelAgreementURL) Loads application group SLA from a specified URL. |
void |
loadApplicationGroupSlaFromUrlByType(String slaType, String applicationGroupIdentifier, String serviceLevelAgreementURL) Loads a system or custom SLA from a specified URL for an application group. |
void |
loadGlobalNodeSla(String fileContent) Loads the provided global node SLA. |
void |
loadGlobalNodeSlaFromUrl(String serviceLevelAgreementURL) Loads a global node SLA from the specified URL. |
void |
loadGlobalSlaByType(String slaType, String fileContent) Loads a system level or a custom SLA for a global scope. |
void |
loadGlobalSlaFromUrlByType(String slaType, String serviceLevelAgreementURL) Loads a system level or custom SLA from the specified URL for a global scope. |
void |
loadServiceProviderGroupNodeSla(String serviceProviderGroupIdentifier, String fileContent) Load the provided service provider group node SLA. |
void |
loadServiceProviderGroupNodeSlaFromUrl(String serviceProviderGroupIdentifier, String serviceLevelAgreementURL) Load service provider group node SLA from specified URL. |
void |
loadServiceProviderGroupSla(String serviceProviderGroupIdentifier, String fileContent) Loads the provided service provider group SLA. |
void |
loadServiceProviderGroupSlaByType(String slaType, String serviceProviderGroupIdentifier, String serviceLevelAgreement) Loads a system level or custom SLA for a service provider group. |
void |
loadServiceProviderGroupSlaFromUrl(String serviceProviderGroupIdentifier, String serviceLevelAgreementURL) Load service provider group SLA from specified URL. |
void |
loadServiceProviderGroupSlaFromUrlByType(String slaType, String serviceProviderGroupIdentifier, String serviceLevelAgreementURL) Loads a system level or custom SLA from a specified URL for a service provider group. |
void |
loadSubscriberSla(String fileContent) Loads subscriber SLA. |
void |
loadSubscriberSlaFromUrl(String serviceLevelAgreementURL) Loads subscriber SLA from a specified URL. |
String |
retrieveApplicationGroupSla(String applicationGroupIdentifier) Retrieves an application group Service Level Agreement. |
String |
retrieveApplicationGroupSlaByType(String slaType, String applicationGroupIdentifier) Retrieves a system or custom Service Level Agreement for a given application group The following system level SLA types are valid for application groups: application - Application group SLA stored and enforced only on the local site. |
String |
retrieveCustomSlaXSDDefinition(String slaType) Retrieves the XSD that defines the type. |
String |
retrieveGlobalNodeSla() Retrieves a global node Service Level Agreement. |
String |
retrieveGlobalSlaByType(String slaType) Retrieves a system level or custom Service Level Agreement for a global scope. |
String |
retrieveServiceProviderGroupNodeSla(String serviceProviderGroupIdentifier) Retrieves a service provider group node Service Level Agreement. |
String |
retrieveServiceProviderGroupSla(String serviceProviderGroupIdentifier) Retrieves a service provider group Service Level Agreement. |
String |
retrieveServiceProviderGroupSlaByType(String slaType, String serviceProviderGroupIdentifier) Retrieves a system level or custom Service Level Agreement for a given service provider group. |
String |
retrieveSubscriberSla() Retrieves a subscriber Service Level Agreement. |
void |
setupCustomSlaXSDDefinition(String slaType, String fileContent) Sets up an XSD document defined as a custom Service Level Agreement type. |
void |
setupCustomSlaXSDDefinitionFromUrl(String slaType, String xsdDocumentURL) Similar to setupCustomSlaXSDDefinition but loads the XSD from a URL. |
Method Detail |
public int countApplicationGroupsByType(String slaType) throws InputManagementException
Scope: Domain
slaType
- a system level application group SLA type ("application" or "system:geo_application") or an SLA type defined by setupCustomSlaXSDDefinition.InputManagementException
- if slaType is null or not applicable.public int countApplicationGroupSlaTypes(String applicationGroupIdentifier)
Scope: Domain
applicationGroupIdentifier
- The application group identifier.public int countApplicationSlaGroups()
Scope: Domain
public int countCustomSlaXSDDefinition()
Scope: Domain
public int countGlobalSlaTypes()
Scope: Domain
public int countServiceProviderGroupsByType(String slaType) throws InputManagementException
Scope: Domain
slaType
- a system level service provider group SLA type ("service_provider", "service_provider_node" or "system:geo_service_provider") or an SLA type defined by setupCustomSlaXSDDefinition.InputManagementException
- if slaType is null or not applicable.public int countServiceProviderGroupSlaTypes(String serviceProviderGroupIdentifier)
Scope: Domain
serviceProviderGroupIdentifier
- The service provider group identifier.public int countServiceProviderSlaGroups()
Scope: Domain
public String[] listApplicationGroupsByType(String slaType, int offset, int size) throws InputManagementException
Scope: Domain
slaType
- a system level application group SLA type ("application" or "system:geo_application") or an SLA type defined by setupCustomSlaXSDDefinitionoffset
- Offset within the complete resultset. Must be >= 0.size
- Number of entries to return. 0 means no limit.InputManagementException
- if slaType is null or not applicable.public String[] listApplicationGroupSlaTypes(String applicationGroupIdentifier, int offset, int size)
Scope: Domain
applicationGroupIdentifier
- The application group identifier.offset
- Offset within the complete resultset. Must be >= 0.size
- Number of entries to return. 0 means no limit.public String[] listApplicationSlaGroups(int offset, int size)
Scope: Domain
offset
- Offset within the complete resultset. Must be >= 0.size
- Number of entries to return. 0 means no limit.public String[] listCustomSlaXSDDefinition(int offset, int size)
Scope: Domain
offset
- Offset within the complete resultset. Must be >= 0.size
- Number of entries to return. 0 means no limit.public String[] listGlobalSlaTypes(int offset, int size)
Scope: Domain
offset
- Offset within the complete resultset. Must be >= 0.size
- Number of entries to return. 0 means no limit.public String[] listServiceProviderGroupsByType(String slaType, int offset, int size) throws InputManagementException
Scope: Domain
slaType
- a system level service provider group SLA type ("service_provider", "service_provider_node" or "system:geo_service_provider") or an SLA type defined by setupCustomSlaXSDDefinitionoffset
- Offset within the complete resultset. Must be >= 0.size
- Number of entries to return. 0 means no limit.InputManagementException
- if slaType is null or not applicable.public String[] listServiceProviderGroupSlaTypes(String serviceProviderGroupIdentifier, int offset, int size)
Scope: Domain
serviceProviderGroupIdentifier
- The service provider group identifier.offset
- Offset within the complete resultset. Must be >= 0.size
- Number of entries to return. 0 means no limit.public String[] listServiceProviderSlaGroups(int offset, int size)
Scope: Domain
offset
- Offset within the complete resultset. Must be >= 0.size
- Number of entries to return. 0 means no limit.public void loadApplicationGroupSla(String applicationGroupIdentifier, String fileContent) throws KeyNotFoundException, ManagementException
Scope: Domain
applicationGroupIdentifier
- The application group to update.fileContent
- The new service level agreement to use. A Null or empty string removes the SLA.ManagementException
- Validation of service level agreement failed.KeyNotFoundException
- If the group does not exist.public void loadApplicationGroupSlaByType(String slaType, String applicationGroupIdentifier, String fileContent) throws ManagementException, KeyNotFoundException, InputManagementException
Scope: Domain
slaType
- A system level application group SLA type ("application" or "system:geo_application") or an SLA type defined by setupCustomSlaXSDDefinitionapplicationGroupIdentifier
- The application group identifier.fileContent
- The new service level agreement to use. A Null or empty string removes the SLA.ManagementException
- Validation of service level agreement failed.KeyNotFoundException
- If the group does not exist.InputManagementException
- if the slaType is null or not applicable.public void loadApplicationGroupSlaFromUrl(String applicationGroupIdentifier, String serviceLevelAgreementURL) throws KeyNotFoundException, ManagementException
Scope: Domain
applicationGroupIdentifier
- The application group to update.serviceLevelAgreementURL
- The URL to the new service level agreement file.ManagementException
- Validation of service level agreement failed.KeyNotFoundException
- If the group does not exist.public void loadApplicationGroupSlaFromUrlByType(String slaType, String applicationGroupIdentifier, String serviceLevelAgreementURL) throws ManagementException, KeyNotFoundException, InputManagementException
Scope: Domain
slaType
- A system level application group SLA type ("application" or "system:geo_application") or an SLA type defined by setupCustomSlaXSDDefinitionapplicationGroupIdentifier
- The application group identifier.serviceLevelAgreementURL
- The new service level agreement to use. A Null or empty string removes the SLA.ManagementException
- Validation of service level agreement failed.KeyNotFoundException
- If the group does not exist.InputManagementException
- if slaType is null or not applicable.public void loadGlobalNodeSla(String fileContent) throws ManagementException
Scope: Domain
fileContent
- The new service level agreement to use. A Null or empty string removes SLA.ManagementException
- Validation of service level agreement failed.public void loadGlobalNodeSlaFromUrl(String serviceLevelAgreementURL) throws ManagementException
Scope: Domain
serviceLevelAgreementURL
- The URL of the new service level agreement file.ManagementException
- Validation of service level agreement failed.public void loadGlobalSlaByType(String slaType, String fileContent) throws ManagementException, KeyNotFoundException, InputManagementException
Scope: Domain
slaType
- a system level global SLA type ("global_node" or "subscr") or an SLA type defined by setupCustomSlaXSDDefinition.fileContent
- The new service level agreement to use. A Null or empty string removes the SLA.ManagementException
- Validation of service level agreement failed.KeyNotFoundException
- If the group does not exist.InputManagementException
- if slaType is null or not applicable.public void loadGlobalSlaFromUrlByType(String slaType, String serviceLevelAgreementURL) throws ManagementException, KeyNotFoundException, InputManagementException
Scope: Domain
slaType
- a system level global SLA type ("global_node" or "subscr") or an SLA type defined by setupCustomSlaXSDDefinition.serviceLevelAgreementURL
- The new service level agreement to use. A Null or empty string removes the SLA.ManagementException
- Validation of service level agreement failed.KeyNotFoundException
- If the group does not exist.InputManagementException
- if slaType is null or not applicable.public void loadServiceProviderGroupNodeSla(String serviceProviderGroupIdentifier, String fileContent) throws KeyNotFoundException, ManagementException
Scope: Domain
serviceProviderGroupIdentifier
- The service provider group to update.fileContent
- The new service level agreement to use. A Null or empty string removes the SLA.ManagementException
- validation of service level agreement failed.KeyNotFoundException
- If the group does not exist.public void loadServiceProviderGroupNodeSlaFromUrl(String serviceProviderGroupIdentifier, String serviceLevelAgreementURL) throws KeyNotFoundException, ManagementException
Scope: Domain
serviceProviderGroupIdentifier
- The service provider group to update.serviceLevelAgreementURL
- The URL to the new service level agreement file.ManagementException
- Validation of service level agreement failed.KeyNotFoundException
- If the group does not exist.public void loadServiceProviderGroupSla(String serviceProviderGroupIdentifier, String fileContent) throws KeyNotFoundException, ManagementException
Scope: Domain
serviceProviderGroupIdentifier
- The service provider group to update.fileContent
- The new service level agreement to use. Null or empty string removes SLA.ManagementException
- validation of service level agreement failed.KeyNotFoundException
- If the group does not exist.public void loadServiceProviderGroupSlaByType(String slaType, String serviceProviderGroupIdentifier, String serviceLevelAgreement) throws ManagementException, KeyNotFoundException, InputManagementException
Scope: Domain
slaType
- a system level service provider group SLA type ("service_provider", "service_provider_node" or "system:geo_service_provider") or an SLA type defined by setupCustomSlaXSDDefinition.serviceProviderGroupIdentifier
- The service provider group identifier.serviceLevelAgreement
- The new service level agreement to use. A Null or empty string removes the SLA.ManagementException
- Validation of service level agreement failed.KeyNotFoundException
- If the group does not exist.InputManagementException
- if slaType is null or not applicable.public void loadServiceProviderGroupSlaFromUrl(String serviceProviderGroupIdentifier, String serviceLevelAgreementURL) throws KeyNotFoundException, ManagementException
Scope: Domain
serviceProviderGroupIdentifier
- The service provider group to update.serviceLevelAgreementURL
- The URL to the new service level agreement file.ManagementException
- validation of service level agreement failed.KeyNotFoundException
- If the group does not exist.public void loadServiceProviderGroupSlaFromUrlByType(String slaType, String serviceProviderGroupIdentifier, String serviceLevelAgreementURL) throws ManagementException, KeyNotFoundException, InputManagementException
Scope: Domain
slaType
- a system level service provider group SLA type ("service_provider", "service_provider_node" or "system:geo_service_provider") or an SLA type defined by setupCustomSlaXSDDefinition.serviceProviderGroupIdentifier
- The service provider group identifier.serviceLevelAgreementURL
- The new service level agreement to use. A Null or empty string removes the SLA.ManagementException
- Validation of service level agreement failed.KeyNotFoundException
- If the group does not exist.InputManagementException
- if slaType is null or not applicable.public void loadSubscriberSla(String fileContent) throws ManagementException
Scope: Domain
fileContent
- The new service level agreement.ManagementException
- Validation of service level agreement failed.KeyNotFoundException
- If the group does not exist.public void loadSubscriberSlaFromUrl(String serviceLevelAgreementURL) throws ManagementException
Scope: Domain
serviceLevelAgreementURL
- The URL of the new service level agreement file.ManagementException
- Validation of service level agreement failed.KeyNotFoundException
- If the group does not exist.public String retrieveApplicationGroupSla(String applicationGroupIdentifier)
Scope: Domain
applicationGroupIdentifier
- The application group identifier.public String retrieveApplicationGroupSlaByType(String slaType, String applicationGroupIdentifier) throws InputManagementException
Scope: Domain
slaType
- a system level application group SLA type ("application" or "system:geo_application") or an SLA type defined by setupCustomSlaXSDDefinitionapplicationGroupIdentifier
- The application group identifier.InputManagementException
- if slaType is null or not applicable.public String retrieveCustomSlaXSDDefinition(String slaType) throws InputManagementException
Scope: Domain
slaType
- The named type of the XSD document.InputManagementException
- if slaType has the same name as a system SLA.public String retrieveGlobalNodeSla()
Scope: Domain
public String retrieveGlobalSlaByType(String slaType) throws InputManagementException
Scope: Domain
slaType
- a system level global SLA type ("global_node" or "subscr") or an SLA type defined by setupCustomSlaXSDDefinition.InputManagementException
- if slaType is null or not applicable.public String retrieveServiceProviderGroupNodeSla(String serviceProviderGroupIdentifier)
Scope: Domain
serviceProviderGroupIdentifier
- The service provider group identifier.public String retrieveServiceProviderGroupSla(String serviceProviderGroupIdentifier)
Scope: Domain
serviceProviderGroupIdentifier
- The service provider group identifier.public String retrieveServiceProviderGroupSlaByType(String slaType, String serviceProviderGroupIdentifier) throws InputManagementException
Scope: Domain
slaType
- a system level service provider group SLA type ("service_provider", "service_provider_node" or "system:geo_service_provider") or an SLA type defined by setupCustomSlaXSDDefinition.serviceProviderGroupIdentifier
- The service provider group identifier.InputManagementException
- if slaType is null or not applicable.public String retrieveSubscriberSla()
Scope: Domain
public void setupCustomSlaXSDDefinition(String slaType, String fileContent) throws ManagementException, InputManagementException
Scope: Domain
slaType
- The named type of the XSD document.fileContent
- The XSD document that describes the custom type.ManagementException
- Validation of XSD failed.InputManagementException
- if the slaType has the same name as a system SLA.public void setupCustomSlaXSDDefinitionFromUrl(String slaType, String xsdDocumentURL) throws ManagementException, InputManagementException
Scope: Domain
slaType
- The named type of the XSD document.xsdDocumentURL
- The URL to the XSD document that describes the custom type.ManagementException
- Validation of the XSD failed.InputManagementException
- if slaType has the same name as a system SLA.
|
Oracle Communications Services Gatekeeper OAM Java API Reference 6.0 E55516-02 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |