com.oracle.bmc.threatintelligence

Interface ThreatintelAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ThreatintelAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220901")
public interface ThreatintelAsync
extends AutoCloseable

Use the Threat Intelligence API to search for information about known threat indicators, including suspicious IP addresses, domain names, and other digital fingerprints. Threat Intelligence is a managed database of curated threat intelligence that comes from first party Oracle security insights, open source feeds, and vendor-procured data. For more information, see the Threat Intelligence documentation.

Method Summary

Modifier and Type	Method and Description
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetIndicatorResponse>	getIndicator(GetIndicatorRequest request, AsyncHandler<GetIndicatorRequest,GetIndicatorResponse> handler) Get detailed information about a threat indicator with a given identifier.
Future<ListIndicatorCountsResponse>	listIndicatorCounts(ListIndicatorCountsRequest request, AsyncHandler<ListIndicatorCountsRequest,ListIndicatorCountsResponse> handler) Get the current count of each threat indicator type.
Future<ListIndicatorsResponse>	listIndicators(ListIndicatorsRequest request, AsyncHandler<ListIndicatorsRequest,ListIndicatorsResponse> handler) Get a list of threat indicator summaries based on the search criteria.
Future<ListThreatTypesResponse>	listThreatTypes(ListThreatTypesRequest request, AsyncHandler<ListThreatTypesRequest,ListThreatTypesResponse> handler) Gets a list of threat types that are available to use as parameters when querying indicators.
void	refreshClient() Rebuilds the client from scratch.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
Future<SummarizeIndicatorsResponse>	summarizeIndicators(SummarizeIndicatorsRequest request, AsyncHandler<SummarizeIndicatorsRequest,SummarizeIndicatorsResponse> handler) Get indicator summaries based on advanced search criteria.
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

refreshClient

void refreshClient()

Rebuilds the client from scratch. Useful to refresh certificates.

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the serice.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Parameters:

regionId - The public region ID.

useRealmSpecificEndpointTemplate

void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)

Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

Parameters:

realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

getIndicator

Future<GetIndicatorResponse> getIndicator(GetIndicatorRequest request,
                                          AsyncHandler<GetIndicatorRequest,GetIndicatorResponse> handler)

Get detailed information about a threat indicator with a given identifier.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listIndicatorCounts

Future<ListIndicatorCountsResponse> listIndicatorCounts(ListIndicatorCountsRequest request,
                                                        AsyncHandler<ListIndicatorCountsRequest,ListIndicatorCountsResponse> handler)

Get the current count of each threat indicator type. Indicator counts can be sorted in ascending or descending order.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listIndicators

Future<ListIndicatorsResponse> listIndicators(ListIndicatorsRequest request,
                                              AsyncHandler<ListIndicatorsRequest,ListIndicatorsResponse> handler)

Get a list of threat indicator summaries based on the search criteria.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listThreatTypes

Future<ListThreatTypesResponse> listThreatTypes(ListThreatTypesRequest request,
                                                AsyncHandler<ListThreatTypesRequest,ListThreatTypesResponse> handler)

Gets a list of threat types that are available to use as parameters when querying indicators. The list is sorted by threat type name according to the sort order query param.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

summarizeIndicators

Future<SummarizeIndicatorsResponse> summarizeIndicators(SummarizeIndicatorsRequest request,
                                                        AsyncHandler<SummarizeIndicatorsRequest,SummarizeIndicatorsResponse> handler)

Get indicator summaries based on advanced search criteria.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.