com.softlayer.api.service.network.TippingPointReporting Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
package com.softlayer.api.service.network;
import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.container.network.intrusionprotection.Statistics;
import com.softlayer.api.service.container.network.intrusionprotection.SubnetReport;
import java.util.List;
import java.util.concurrent.Future;
/**
* This general purpose class is used to retrieve intrusion protection statistics from the tipping point hardware located on the softlayer network.
*
* Every customer has access to the global intrusion protection statistics, as well as the detailed statistics for that user's account.
*
* No actions can be taken using this system, it is for statistical reporting purposes only. If an attacking IP is identified using this system, please use the firewall system to take any actions that are appropriate.
*
* This system reports attacks on all SoftLayer data centers.
*
* @see SoftLayer_Network_TippingPointReporting
*/
@ApiType("SoftLayer_Network_TippingPointReporting")
public class TippingPointReporting extends Entity {
public static Service service(ApiClient client) {
return client.createService(Service.class, null);
}
/**
* This general purpose class is used to retrieve intrusion protection statistics from the tipping point hardware located on the softlayer network.
*
* Every customer has access to the global intrusion protection statistics, as well as the detailed statistics for that user's account.
*
* No actions can be taken using this system, it is for statistical reporting purposes only. If an attacking IP is identified using this system, please use the firewall system to take any actions that are appropriate.
*
* This system reports attacks on all SoftLayer data centers.
*
* @see SoftLayer_Network_TippingPointReporting
*/
@com.softlayer.api.annotation.ApiService("SoftLayer_Network_TippingPointReporting")
public static interface Service extends com.softlayer.api.Service {
public ServiceAsync asAsync();
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* This method, when given an attack signature ID (available in the return values of getReportForIpAddressOrSubnet and getSubnetReportForEntireAccount) and an IP Address and subnet mask, returns all attacks for that subnet in the specified time frame and direction. Once the results have been filtered, additional data is available, including starting and ending times for the attack, originating IP address and port, and destination IP address and port.
*
* CVE and Bugtraq information is not available at this level.
*
* @see SoftLayer_Network_TippingPointReporting::drillDownAttack
*/
@ApiMethod
public SubnetReport drillDownAttack(String signatureId, String IpAddress, Long subnetMask, Long timeFrame, String direction);
/**
* This method returns the attack statistics for the current user's account and for the entire SoftLayer network. These attacks are recorded and monitored at the entry point to the network, and represent attacks in both directions.
*
* The data returned is:
* * Top attacks (by attack name) on datacenter Dal01 in the last hour (and last 24 hours)
* * Top attacks (by attack name) on IPs you own in the last hour (and last 24 hours)
* * Top IPs attacking IPs you own in the last hour (and last 24 hours)
* Each one of these lists can contain any number of items, the default is 5. The usable limit is less than 10, but setting the limit to an abnormally high value will effectively return all records.
*
* The data is returned as a collection of SoftLayer_Container_Network_IntrusionProtection_Statistics objects.
*
* @see SoftLayer_Network_TippingPointReporting::getMainStatistics
*/
@ApiMethod
public List getMainStatistics(Long numberOfAttacks);
/**
* This method expands on the getSubnetReportForEntireAccount method by offering the ability to filter by subnet or IP address. This method is identical to getSubnetReportForEntireAccount, but allows filtering by subnet. Like in the getSubnetReportForEntireAccount method, CVE and BugTraq IDs are provided, if available.
*
* This method should be called once an attack has been identified using getSubnetReportForEntireAccount (in which case "All Subnets" is the subnet) or getReportForIpAddressOrSubnet.
*
* @see SoftLayer_Network_TippingPointReporting::getReportForIpAddressOrSubnet
*/
@ApiMethod
public List getReportForIpAddressOrSubnet(String IpAddress, Long subnetMask, Long timeFrame, String orderBy, String orderDirection);
/**
* This method returns specific attacks by name for all subnets on the current user's account.
*
* The data returned is stored in SoftLayer_Container_Network_IntrusionProtection_SubnetReport objects, with the "subnet" value set to "All Subnets"
*
* The data is separated into "Inbound" and "Outbound" traffic. A significant amount of outbound attack traffic could indicate that your servers have been compromised.
*
* The data returned includes Attack Count, attack name, extended attack description, and IDs that correspond with the BugTraq or CVE databases. BugTraq can be accessed at [http://www.securityfocus.com/vulnerabilities] The CVE database is located at [http://cve.mitre.org/find/index.html]
*
* For more detailed information, use the getReportForIpAddressOrSubnet method
*
* @see SoftLayer_Network_TippingPointReporting::getSubnetReportForEntireAccount
*/
@ApiMethod
public List getSubnetReportForEntireAccount(Long timeFrame, String orderBy, String orderDirection, Boolean returnSubnetGroups);
}
public static interface ServiceAsync extends com.softlayer.api.ServiceAsync {
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* Async version of {@link Service#drillDownAttack}
*/
public Future drillDownAttack(String signatureId, String IpAddress, Long subnetMask, Long timeFrame, String direction);
public Future drillDownAttack(String signatureId, String IpAddress, Long subnetMask, Long timeFrame, String direction, ResponseHandler callback);
/**
* Async version of {@link Service#getMainStatistics}
*/
public Future> getMainStatistics(Long numberOfAttacks);
public Future getMainStatistics(Long numberOfAttacks, ResponseHandler> callback);
/**
* Async version of {@link Service#getReportForIpAddressOrSubnet}
*/
public Future> getReportForIpAddressOrSubnet(String IpAddress, Long subnetMask, Long timeFrame, String orderBy, String orderDirection);
public Future getReportForIpAddressOrSubnet(String IpAddress, Long subnetMask, Long timeFrame, String orderBy, String orderDirection, ResponseHandler> callback);
/**
* Async version of {@link Service#getSubnetReportForEntireAccount}
*/
public Future> getSubnetReportForEntireAccount(Long timeFrame, String orderBy, String orderDirection, Boolean returnSubnetGroups);
public Future getSubnetReportForEntireAccount(Long timeFrame, String orderBy, String orderDirection, Boolean returnSubnetGroups, ResponseHandler> callback);
}
public static class Mask extends com.softlayer.api.service.Entity.Mask {
}
}