Package org.wso2.am.integration.test.impl

Class RestAPIGovernanceImpl

java.lang.Object

org.wso2.am.integration.test.impl.RestAPIGovernanceImpl

public class RestAPIGovernanceImpl
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
ApiClient	apiGovernanceClient
static String	appName
static String	appOwner
static String	callBackURL
static String	grantType
static String	password
String	tenantDomain
static String	tokenScope
static String	username

Constructor Summary

Constructors

Constructor	Description
RestAPIGovernanceImpl(String username, String password, String tenantDomain, String url)	Constructor for the RestAPIGovernanceImpl

Method Summary

Modifier and Type	Method	Description
ApiResponse<APIMGovernancePolicyDTO>	createPolicy(APIMGovernancePolicyDTO policyDTO)	Create a new governance policy
ApiResponse<RulesetInfoDTO>	createRuleset(String name, File rulesetContent, String ruleType, String artifactType, String description, String ruleCategory, String documentationLink, String provider)	Create a new ruleset
ApiResponse<Void>	deletePolicy(String policyId)	Delete a governance policy
ApiResponse<Void>	deleteRuleset(String rulesetId)	Delete a ruleset
ApiResponse<ArtifactComplianceDetailsDTO>	getAPICompliance(String apiId)	Get the compliance details of an artifact
ApiResponse<APIMGovernancePolicyListDTO>	getPolicies(Integer limit, Integer offset, String query)	Get all governance policies
ApiResponse<APIMGovernancePolicyDTO>	getPolicy(String policyId)	Get a governance policy
ApiResponse<PolicyAdherenceDetailsDTO>	getPolicyAdherence(String poilcyId)	Get the policy adherence details of a policy
ApiResponse<RulesetInfoDTO>	getRuleset(String rulesetId)	Get a ruleset
ApiResponse<RulesetListDTO>	getRulesets(Integer limit, Integer offset, String query)	Get all rulesets
ApiResponse<APIMGovernancePolicyDTO>	updatePolicy(String policyId, APIMGovernancePolicyDTO policyDTO)	Update an existing governance policy
ApiResponse<RulesetInfoDTO>	updateRuleset(String rulesetId, String name, File rulesetContent, String ruleType, String artifactType, String description, String ruleCategory, String documentationLink, String provider)	Update an existing ruleset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

apiGovernanceClient

public ApiClient apiGovernanceClient

appName

public static final String appName

See Also:

Constant Field Values

callBackURL

public static final String callBackURL

See Also:

Constant Field Values

tokenScope

public static final String tokenScope

See Also:

Constant Field Values

appOwner

public static final String appOwner

See Also:

Constant Field Values

grantType

public static final String grantType

See Also:

Constant Field Values

username

public static final String username

See Also:

Constant Field Values

password

public static final String password

See Also:

Constant Field Values

tenantDomain

public String tenantDomain

Constructor Detail

RestAPIGovernanceImpl

public RestAPIGovernanceImpl(String username,
                             String password,
                             String tenantDomain,
                             String url)

Constructor for the RestAPIGovernanceImpl

Parameters:

username - Username of the user

password - Password of the user

tenantDomain - Tenant domain of the user

url - server URL

Method Detail

createRuleset

public ApiResponse<RulesetInfoDTO> createRuleset(String name,
                                                 File rulesetContent,
                                                 String ruleType,
                                                 String artifactType,
                                                 String description,
                                                 String ruleCategory,
                                                 String documentationLink,
                                                 String provider)
                                          throws ApiException

Create a new ruleset

Parameters:

name - Name of the ruleset

rulesetContent - Content of the ruleset

ruleType - Type of the rule

artifactType - Type of the artifact

description - Description of the ruleset

ruleCategory - Category of the rule

documentationLink - Documentation link of the ruleset

provider - Provider of the ruleset

Returns:

RulesetInfoDTO

Throws:

ApiException - If there is an issue with the API request

updateRuleset

public ApiResponse<RulesetInfoDTO> updateRuleset(String rulesetId,
                                                 String name,
                                                 File rulesetContent,
                                                 String ruleType,
                                                 String artifactType,
                                                 String description,
                                                 String ruleCategory,
                                                 String documentationLink,
                                                 String provider)
                                          throws ApiException

Update an existing ruleset

Parameters:

rulesetId - Id of the ruleset

name - Name of the ruleset

rulesetContent - Content of the ruleset

ruleType - Type of the rule

artifactType - Type of the artifact

description - Description of the ruleset

ruleCategory - Category of the rule

documentationLink - Documentation link of the ruleset

provider - Provider of the ruleset

Returns:

RulesetInfoDTO

Throws:

ApiException - If there is an issue with the API request

deleteRuleset

public ApiResponse<Void> deleteRuleset(String rulesetId)
                                throws ApiException

Delete a ruleset

Parameters:

rulesetId - Id of the ruleset

Returns:

Void

Throws:

ApiException - If there is an issue with the API request

getRuleset

public ApiResponse<RulesetInfoDTO> getRuleset(String rulesetId)
                                       throws ApiException

Get a ruleset

Parameters:

rulesetId - Id of the ruleset

Returns:

RulesetInfoDTO

Throws:

ApiException - If there is an issue with the API request

getRulesets

public ApiResponse<RulesetListDTO> getRulesets(Integer limit,
                                               Integer offset,
                                               String query)
                                        throws ApiException

Get all rulesets

Parameters:

limit - Limit of the rulesets

offset - Offset of the rulesets

query - Query to search for rulesets

Returns:

RulesetListDTO

Throws:

ApiException - If there is an issue with the API request

createPolicy

public ApiResponse<APIMGovernancePolicyDTO> createPolicy(APIMGovernancePolicyDTO policyDTO)
                                                  throws ApiException

Create a new governance policy

Parameters:

policyDTO - APIMGovernancePolicyDTO object

Returns:

APIMGovernancePolicyDTO

Throws:

ApiException - If there is an issue with the API request

updatePolicy

public ApiResponse<APIMGovernancePolicyDTO> updatePolicy(String policyId,
                                                         APIMGovernancePolicyDTO policyDTO)
                                                  throws ApiException

Update an existing governance policy

Parameters:

policyId - Id of the policy

policyDTO - APIMGovernancePolicyDTO object

Returns:

APIMGovernancePolicyDTO

Throws:

ApiException - If there is an issue with the API request

deletePolicy

public ApiResponse<Void> deletePolicy(String policyId)
                               throws ApiException

Delete a governance policy

Parameters:

policyId - Id of the policy

Returns:

Void

Throws:

ApiException - If there is an issue with the API request

getPolicy

public ApiResponse<APIMGovernancePolicyDTO> getPolicy(String policyId)
                                               throws ApiException

Get a governance policy

Parameters:

policyId - Id of the policy

Returns:

APIMGovernancePolicyDTO

Throws:

ApiException - If there is an issue with the API request

getPolicies

public ApiResponse<APIMGovernancePolicyListDTO> getPolicies(Integer limit,
                                                            Integer offset,
                                                            String query)
                                                     throws ApiException

Get all governance policies

Parameters:

limit - Limit of the policies

offset - Offset of the policies

query - Query to search for policies

Returns:

APIMGovernancePolicyListDTO

Throws:

ApiException - If there is an issue with the API request

getAPICompliance

public ApiResponse<ArtifactComplianceDetailsDTO> getAPICompliance(String apiId)
                                                           throws ApiException

Get the compliance details of an artifact

Parameters:

apiId - Id of the API

Returns:

ArtifactComplianceDetailsDTO

Throws:

ApiException - If there is an issue with the API request

getPolicyAdherence

public ApiResponse<PolicyAdherenceDetailsDTO> getPolicyAdherence(String poilcyId)
                                                          throws ApiException

Get the policy adherence details of a policy

Parameters:

poilcyId - Id of the policy

Returns:

PolicyAdherenceDetailsDTO

Throws:

ApiException - If there is an issue with the API request