Skip navigation links

Oracle Communications Services Gatekeeper OAM Java API Reference
6.0

E55516-02


com.bea.wlcp.wlng.account.management
Interface ApplicationGroupMBean


public interface ApplicationGroupMBean

Method Summary
 void addApplicationGroup(String applicationGroupIdentifier)
          Adds an application group with attached service level agreements.
 void addServiceProviderGroup(String serviceProviderGroupIdentifier)
          Adds a service provider group with attached service level agreements.
 void addServiceProviderGroup(String serviceProviderGroupIdentifier, Serializable properties)
          Adds a service provider group with attached service level agreements.
 int countApplicationGroups()
          Counts the number of application groups.
 int countServiceProviderGroups()
          Counts the number of service provider groups.
 ApplicationGroupDescription getApplicationGroup(String applicationGroupIdentifier)
          Gets an application group description.
 ServiceProviderGroupDescription getServiceProviderGroup(String serviceProviderGroupIdentifier)
          Gets the service provider group description.
 String[] listApplicationGroups(int offset, int size)
          Lists application groups.
 String[] listServiceProviderGroups(int offset, int size)
          Lists service provider groups.
 void removeApplicationGroup(String applicationGroupIdentifier)
          Removes an empty application group.
 void removeServiceProviderGroup(String serviceProviderGroupIdentifier)
          Removes an empty service provider group.
 void setApplicationGroupProperties(String applicationGroupIdentifier, Set properties)
          Sets properties for an application group.
 void setServiceProviderGroupProperties(String serviceProviderGroupIdentifier, Set properties)
          Sets properties for a service provider group.
 void setServiceProviderGroupPropertiesByString(String serviceProviderGroupIdentifier, String properties)
          Sets properties by string for a service provider group.

 

Method Detail

addApplicationGroup

public void addApplicationGroup(String applicationGroupIdentifier)
                         throws DuplicateKeyException,
                                ManagementException
Adds an application group with attached service level agreements.

Scope: Domain

Parameters:
applicationGroupIdentifier - The group identifier.
Throws:
com.bea.wlcp.wlng.api.management.DuplicateKeyException - If the account group already exists or there were duplicate service level agreements specified.
com.bea.wlcp.wlng.api.management.ManagementException - If an unexpected error occurred.
DuplicateKeyException
ManagementException

addServiceProviderGroup

public void addServiceProviderGroup(String serviceProviderGroupIdentifier)
                             throws DuplicateKeyException,
                                    ManagementException
Adds a service provider group with attached service level agreements.

Scope: Domain

Parameters:
serviceProviderGroupIdentifier - The group identifier.
Throws:
com.bea.wlcp.wlng.api.management.DuplicateKeyException - If the account group already exists or there were duplicate service level agreements specified.
com.bea.wlcp.wlng.api.management.ManagementException - If an unexpected error occurred.
DuplicateKeyException
ManagementException

addServiceProviderGroup

public void addServiceProviderGroup(String serviceProviderGroupIdentifier,
                                    Serializable properties)
                             throws DuplicateKeyException,
                                    ManagementException
Adds a service provider group with attached service level agreements.

Scope: Domain

Parameters:
serviceProviderGroupIdentifier - The group identifier.
properties - Properties.
Throws:
com.bea.wlcp.wlng.api.management.DuplicateKeyException - If the account group already exists or there were duplicate service level agreements specified.
com.bea.wlcp.wlng.api.management.ManagementException - If an unexpected error occurred.
DuplicateKeyException
ManagementException

countApplicationGroups

public int countApplicationGroups()
Counts the number of application groups.

Scope: Domain

Returns:
The account group count.

countServiceProviderGroups

public int countServiceProviderGroups()
Counts the number of service provider groups.

Scope: Domain

Returns:
The account group count.

getApplicationGroup

public ApplicationGroupDescription getApplicationGroup(String applicationGroupIdentifier)
Gets an application group description. Returns the application group description and account properties.

Scope: Domain

Parameters:
applicationGroupIdentifier - The account group identifier.
Returns:
The account group description.

getServiceProviderGroup

public ServiceProviderGroupDescription getServiceProviderGroup(String serviceProviderGroupIdentifier)
Gets the service provider group description. Returns the service provider group description and account properties.

Scope: Domain

Parameters:
serviceProviderGroupIdentifier - The account group identifier.
Returns:
The account group description.

listApplicationGroups

public String[] listApplicationGroups(int offset,
                                      int size)
Lists application groups.

Scope: Domain

Parameters:
offset - Offset within the complete resultset. Must be >= 0.
size - Number of entries to return. 0 means no limit.
Returns:
The account groups matching the criteria.

listServiceProviderGroups

public String[] listServiceProviderGroups(int offset,
                                          int size)
Lists service provider groups.

Scope: Domain

Parameters:
offset - Offset within the complete resultset. Must be >= 0.
size - Number of entries to return. 0 means no limit.
Returns:
The account groups matching the criteria.

removeApplicationGroup

public void removeApplicationGroup(String applicationGroupIdentifier)
                            throws ManagementException
Removes an empty application group. Removing the group is not allowed if it contains accounts.

Scope: Domain

Parameters:
applicationGroupIdentifier - The group to remove.
Throws:
com.bea.wlcp.wlng.api.management.ManagementException - If the group contains accounts.
ManagementException

removeServiceProviderGroup

public void removeServiceProviderGroup(String serviceProviderGroupIdentifier)
                                throws ManagementException
Removes an empty service provider group. Removing the group is not allowed if it contains accounts.

Scope: Domain

Parameters:
serviceProviderGroupIdentifier - The group to remove.
Throws:
com.bea.wlcp.wlng.api.management.ManagementException - If the group contains accounts.
ManagementException

setApplicationGroupProperties

public void setApplicationGroupProperties(String applicationGroupIdentifier,
                                          Set properties)
                                   throws KeyNotFoundException
Sets properties for an application group.

Scope: Domain

Parameters:
applicationGroupIdentifier - The group to update.
properties - The new properties. A set with Map.Entry<String, String>.
Throws:
com.bea.wlcp.wlng.api.management.KeyNotFoundException - If the group does not exist.
KeyNotFoundException

setServiceProviderGroupProperties

public void setServiceProviderGroupProperties(String serviceProviderGroupIdentifier,
                                              Set properties)
                                       throws KeyNotFoundException
Sets properties for a service provider group.

Note: Only applicable when the MBean is accessed directly.

Scope: Domain

Parameters:
serviceProviderGroupIdentifier - The group to update.
properties - The new properties. A set with Map.Entry<String, String>.
Throws:
com.bea.wlcp.wlng.api.management.KeyNotFoundException - If the group does not exist.
KeyNotFoundException

setServiceProviderGroupPropertiesByString

public void setServiceProviderGroupPropertiesByString(String serviceProviderGroupIdentifier,
                                                      String properties)
                                               throws KeyNotFoundException,
                                                      ManagementException
Sets properties by string for a service provider group.

Note: Only applicable when the MBean is accessed directly.

Scope: Domain

Parameters:
serviceProviderGroupIdentifier - The group to update.
properties - The new properties. A string with format "key1=value1;key2=value2;..."
Throws:
com.bea.wlcp.wlng.api.management.KeyNotFoundException - If the group does not exist.
KeyNotFoundException
ManagementException

Skip navigation links

Oracle Communications Services Gatekeeper OAM Java API Reference
6.0

E55516-02


Copyright © 2008, 2015, Oracle and/or its affiliates. All rights reserved.