|
Oracle Communications Services Gatekeeper OAM Java API Reference 5.0 E21718-01 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Field Summary | |
static CounterInfo |
counterSnapshot Gets a counter snapshot for the local server. |
static CounterInfo[] |
counterSnapshotAll Gets a counter snapshot for the all servers in the cluster. |
static int |
moduleBHTUPSThreshold BHTUPS 95% warning and limit exceeded alarm threshold setting for the modules transaction group. |
static int |
platformBHTUPSThreshold BHTUPS 95% warning and limit exceeded alarm threshold setting for the platform transaction group. |
static int |
storeInterval Interval in number of seconds that statistics data is written to DB. |
Method Summary | |
void |
addStatisticType(int id, String name) Adds a statistic type. |
void |
createLicenseLimitLog(String filename, String startDate, String endDate) Create a license limit supervision log that contains information about the busy hour transaction rate for each transaction group and day during the time period specified. |
void |
createWeeklyReport(String serviceProviderIdentifier, String startDate, String fileName, int decimals) Saves a weekly report to a text file. |
CounterInfo |
getCounterSnapshot() |
CounterInfo[] |
getCounterSnapshotAll() |
int |
getModuleBHTUPSThreshold() |
int |
getPlatformBHTUPSThreshold() |
StatisticsInfo[] |
getStatistics(String serverName, int statisticType, String fromDate, String toDate, String serviceProviderIdentifier, String applicationIdentifier) Gets statistics based on filter criteria for a specific account. |
int |
getStoreInterval() |
String |
getSystemStatistics(int minutes) Gets system statistics for the last minute(s). |
StatInfo[] |
listStatistics(int statisticType, long fromDate, long toDate, String serviceProviderIdentifier, String applicationIdentifier) Gets statistics based on filter criteria for a specific account. |
StatisticTypeDescriptor[] |
listStatisticTypeDescriptors() Lists all available statistic types with descriptor structures |
String |
listStatisticTypes() Lists all available statistic types |
void |
removeStatisticType(int id) Removes a statistic type. |
void |
saveAccountStatisticsToFile(int statisticType, String fromDate, String toDate, String serviceProviderIdentifier, String applicationIdentifier, String fileName) Saves statistics data to a file grouped by account based on specified filter criteria. |
void |
saveStatisticsToFile(String serverName, int statisticType, String fromDate, String toDate, String fileName) Saves statistics data to a file on filter criteria. |
void |
setModuleBHTUPSThreshold(int threshold) |
void |
setPlatformBHTUPSThreshold(int threshold) |
void |
setStoreInterval(int seconds) |
Field Detail |
public static final CounterInfo counterSnapshot
public static final CounterInfo[] counterSnapshotAll
public static final int moduleBHTUPSThreshold
public static final int platformBHTUPSThreshold
public static final int storeInterval
Method Detail |
public void addStatisticType(int id, String name) throws ManagementException
id
- Id for this statistics. The id must not be already used.name
- Descriptive name for the statistics typeManagementException
public void createLicenseLimitLog(String filename, String startDate, String endDate) throws ManagementException
filename
- Name of file. The file will be created on the local file system of the server.startDate
- Start date specified as yyyy-mm-ddendDate
- End date specified as yyyy-mm-ddManagementException
public void createWeeklyReport(String serviceProviderIdentifier, String startDate, String fileName, int decimals) throws ManagementException
serviceProviderIdentifier
- Service provider account.startDate
- From date specified as yyyy-mm-dd hh:mmfileName
- Name of file. The file will be created on the local file system of the server.decimals
- Number of decimals for transactions/second.ManagementException
public CounterInfo getCounterSnapshot() throws ManagementException
ManagementException
public CounterInfo[] getCounterSnapshotAll() throws ManagementException
ManagementException
public int getModuleBHTUPSThreshold() throws ManagementException
ManagementException
public int getPlatformBHTUPSThreshold() throws ManagementException
ManagementException
public StatisticsInfo[] getStatistics(String serverName, int statisticType, String fromDate, String toDate, String serviceProviderIdentifier, String applicationIdentifier) throws ManagementException
serverName
- The server that generated the statistics. (optional)statisticType
- Type of statistics. Use listStatisticTypes to obtain available types. Use -1 to get statistics for all available types.fromDate
- From date specified as yyyy-mm-dd hh:mm (optional)toDate
- To date specified as yyyy-mm-dd hh:mm (optional)serviceProviderIdentifier
- Service provider account (optional)applicationIdentifier
- Application account (optional)ManagementException
public int getStoreInterval() throws ManagementException
ManagementException
public String getSystemStatistics(int minutes) throws ManagementException
minutes
- MinutesManagementException
public StatInfo[] listStatistics(int statisticType, long fromDate, long toDate, String serviceProviderIdentifier, String applicationIdentifier) throws ManagementException
statisticType
- Type of statistics. Use listStatisticTypes to obtain available types. Use -1 to get statistics for all available types.fromDate
- From date in milliseconds. Use -1 for no lower date limit.toDate
- To date in milliseconds. Use -1 for no upper date limit.serviceProviderIdentifier
- Service provider account (optional)applicationIdentifier
- Application account (optional)ManagementException
public StatisticTypeDescriptor[] listStatisticTypeDescriptors() throws ManagementException
ManagementException
public String listStatisticTypes() throws ManagementException
ManagementException
public void removeStatisticType(int id) throws ManagementException
id
- Id for this statistics. The id must not be already used.ManagementException
public void saveAccountStatisticsToFile(int statisticType, String fromDate, String toDate, String serviceProviderIdentifier, String applicationIdentifier, String fileName) throws ManagementException
statisticType
- Type of statistics. Use listStatisticTypes to obtain available types. Use -1 to get statistics for all available types.fromDate
- From date specified as yyyy-mm-dd hh:mm (optional)toDate
- To date specified as yyyy-mm-dd hh:mm (optional)serviceProviderIdentifier
- Service provider account (optional)applicationIdentifier
- Application account (optional)fileName
- Name of file. The file will be created on the local file system of the server.ManagementException
public void saveStatisticsToFile(String serverName, int statisticType, String fromDate, String toDate, String fileName) throws ManagementException
serverName
- The server that generated the statistics. (optional)statisticType
- Type of statistics. Use listStatisticTypes to obtain available types. Use -1 to get statistics for all available types.fromDate
- From date specified as yyyy-mm-dd hh:mm (optional)toDate
- To date specified as yyyy-mm-dd hh:mm (optional)fileName
- Name of file. The file will be created on the local file system of the server.ManagementException
public void setModuleBHTUPSThreshold(int threshold) throws ManagementException
ManagementException
public void setPlatformBHTUPSThreshold(int threshold) throws ManagementException
ManagementException
public void setStoreInterval(int seconds) throws ManagementException
ManagementException
|
Oracle Communications Services Gatekeeper OAM Java API Reference 5.0 E21718-01 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |