io.apiman.manager.api.rest.impl.audit

Class AuditUtils

java.lang.Object

io.apiman.manager.api.rest.impl.audit.AuditUtils

public class AuditUtils
extends Object

Contains a number of methods useful to create and manage audit entries for actions taken by users in the management layer REST API.

Author:

eric.wittmann@redhat.com

Method Summary

Modifier and Type	Method and Description
static AuditEntryBean	apiCreated(ApiBean bean, ISecurityContext securityContext) Creates an audit entry for the 'API created' event.
static AuditEntryBean	apiDefinitionDeleted(ApiVersionBean bean, ISecurityContext securityContext) Creates an audit entry when a API definition is deleted.
static AuditEntryBean	apiDefinitionUpdated(ApiVersionBean bean, ISecurityContext securityContext) Creates an audit entry when a API definition is updated.
static AuditEntryBean	apiPublished(ApiVersionBean bean, ISecurityContext securityContext) Creates an audit entry for the 'API published' event.
static AuditEntryBean	apiRetired(ApiVersionBean bean, ISecurityContext securityContext) Creates an audit entry for the 'API retired' event.
static AuditEntryBean	apiUpdated(ApiBean bean, EntityUpdatedData data, ISecurityContext securityContext) Creates an audit entry for the 'API updated' event.
static AuditEntryBean	apiVersionCreated(ApiVersionBean bean, ISecurityContext securityContext) Creates an audit entry for the 'API version created' event.
static AuditEntryBean	apiVersionUpdated(ApiVersionBean bean, EntityUpdatedData data, ISecurityContext securityContext) Creates an audit entry for the 'API version updated' event.
static String	asString_ApiGatewayBeans(Set<ApiGatewayBean> gateways) Converts the list of gateways to a string for display/comparison.
static String	asString_ApiPlanBeans(Set<ApiPlanBean> plans) Converts the list of plans to a string for display/comparison.
static AuditEntryBean	clientCreated(ClientBean bean, ISecurityContext securityContext) Creates an audit entry for the 'client created' event.
static AuditEntryBean	clientRegistered(ClientVersionBean bean, ISecurityContext securityContext) Creates an audit entry for the 'client registered' event.
static AuditEntryBean	clientUnregistered(ClientVersionBean bean, ISecurityContext securityContext) Creates an audit entry for the 'client unregistered' event.
static AuditEntryBean	clientUpdated(ClientBean bean, EntityUpdatedData data, ISecurityContext securityContext) Creates an audit entry for the 'client updated' event.
static AuditEntryBean	clientVersionCreated(ClientVersionBean bean, ISecurityContext securityContext) Creates an audit entry for the 'client version created' event.
static AuditEntryBean	clientVersionUpdated(ClientVersionBean bean, EntityUpdatedData data, ISecurityContext securityContext) Creates an audit entry for the 'client version updated' event.
static AuditEntryBean	contractBrokenFromClient(ContractBean bean, ISecurityContext securityContext) Creates an audit entry for the 'contract broken' event.
static AuditEntryBean	contractBrokenToApi(ContractBean bean, ISecurityContext securityContext) Creates an audit entry for the 'contract broken' event.
static AuditEntryBean	contractCreatedFromClient(ContractBean bean, ISecurityContext securityContext) Creates an audit entry for the 'contract created' event.
static AuditEntryBean	contractCreatedToApi(ContractBean bean, ISecurityContext securityContext) Creates an audit entry for the 'contract created' event.
static AuditEntryBean	membershipGranted(String organizationId, MembershipData data, ISecurityContext securityContext) Creates an audit entry for the 'membership granted' even.
static AuditEntryBean	membershipRevoked(String organizationId, MembershipData data, ISecurityContext securityContext) Creates an audit entry for the 'membership revoked' even.
static AuditEntryBean	organizationCreated(OrganizationBean bean, ISecurityContext securityContext) Creates an AuditEntryBean for the 'organization created' event.
static AuditEntryBean	organizationUpdated(OrganizationBean bean, EntityUpdatedData data, ISecurityContext securityContext) Creates an audit entry for the 'organization updated' event.
static AuditEntryBean	planCreated(PlanBean bean, ISecurityContext securityContext) Creates an audit entry for the 'plan created' event.
static AuditEntryBean	planLocked(PlanVersionBean bean, ISecurityContext securityContext) Creates an audit entry for the 'plan locked' event.
static AuditEntryBean	planUpdated(PlanBean bean, EntityUpdatedData data, ISecurityContext securityContext) Creates an audit entry for the 'plan updated' event.
static AuditEntryBean	planVersionCreated(PlanVersionBean bean, ISecurityContext securityContext) Creates an audit entry for the 'plan version created' event.
static AuditEntryBean	planVersionUpdated(PlanVersionBean bean, EntityUpdatedData data, ISecurityContext securityContext) Creates an audit entry for the 'plan version updated' event.
static AuditEntryBean	policiesReordered(ApiVersionBean apiVersion, PolicyType policyType, ISecurityContext securityContext) Called when the user reorders the policies in a API.
static AuditEntryBean	policiesReordered(ClientVersionBean cvb, PolicyType policyType, ISecurityContext securityContext) Called when the user reorders the policies in an client.
static AuditEntryBean	policiesReordered(PlanVersionBean pvb, PolicyType policyType, ISecurityContext securityContext) Called when the user reorders the policies in a plan.
static AuditEntryBean	policyAdded(PolicyBean bean, PolicyType type, ISecurityContext securityContext) Creates an audit entry for the 'policy added' event.
static AuditEntryBean	policyRemoved(PolicyBean bean, PolicyType type, ISecurityContext securityContext) Creates an audit entry for the 'policy removed' event.
static AuditEntryBean	policyUpdated(PolicyBean bean, PolicyType type, ISecurityContext securityContext) Creates an audit entry for the 'policy updated' event.
static boolean	valueChanged(Boolean before, Boolean after) Returns true only if the value changed.
static boolean	valueChanged(Enum<?> before, Enum<?> after) Returns true only if the value changed.
static boolean	valueChanged(Map<String,String> before, Map<String,String> after) Returns true only if the map has changed.
static boolean	valueChanged(Set<?> before, Set<?> after) Returns true only if the set has changed.
static boolean	valueChanged(String before, String after) Returns true only if the value changed.

Methods inherited from class java.lang.Object

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

Method Detail

valueChanged

public static boolean valueChanged(String before,
                                   String after)

Returns true only if the value changed.

Parameters:

before - the value before change

after - the value after change

Returns:

true if value changed, else false

valueChanged

public static boolean valueChanged(Boolean before,
                                   Boolean after)

Returns true only if the value changed.

Parameters:

before - the value before change

after - the value after change

Returns:

true if value changed, else false

valueChanged

public static boolean valueChanged(Set<?> before,
                                   Set<?> after)

Returns true only if the set has changed.

Parameters:

before - the value before change

after - the value after change

Returns:

true if value changed, else false

valueChanged

public static boolean valueChanged(Map<String,String> before,
                                   Map<String,String> after)

Returns true only if the map has changed.

Parameters:

before - the value before change

after - the value after change

Returns:

true if value changed, else false

valueChanged

public static boolean valueChanged(Enum<?> before,
                                   Enum<?> after)

Returns true only if the value changed.

Parameters:

before - the value before change

after - the value after change

Returns:

true if value changed, else false

organizationCreated

public static AuditEntryBean organizationCreated(OrganizationBean bean,
                                                 ISecurityContext securityContext)

Creates an AuditEntryBean for the 'organization created' event.

Parameters:

bean - the bean

securityContext - the security context

Returns:

the audit entry

organizationUpdated

public static AuditEntryBean organizationUpdated(OrganizationBean bean,
                                                 EntityUpdatedData data,
                                                 ISecurityContext securityContext)

Creates an audit entry for the 'organization updated' event.

Parameters:

bean - the bean

data - the update

securityContext - the security context

Returns:

the audit entry

membershipGranted

public static AuditEntryBean membershipGranted(String organizationId,
                                               MembershipData data,
                                               ISecurityContext securityContext)

Creates an audit entry for the 'membership granted' even.

Parameters:

organizationId - the organization id

data - the membership data

securityContext - the security context

Returns:

the audit entry

membershipRevoked

public static AuditEntryBean membershipRevoked(String organizationId,
                                               MembershipData data,
                                               ISecurityContext securityContext)

Creates an audit entry for the 'membership revoked' even.

Parameters:

organizationId - the organization id

data - the membership data

securityContext - the security context

Returns:

the audit entry

apiCreated

public static AuditEntryBean apiCreated(ApiBean bean,
                                        ISecurityContext securityContext)

Creates an audit entry for the 'API created' event.

Parameters:

bean - the bean

securityContext - the security context

Returns:

the audit entry

apiUpdated

public static AuditEntryBean apiUpdated(ApiBean bean,
                                        EntityUpdatedData data,
                                        ISecurityContext securityContext)

Creates an audit entry for the 'API updated' event.

Parameters:

bean - the bean

data - the updated data

securityContext - the security context

Returns:

the audit entry

apiVersionCreated

public static AuditEntryBean apiVersionCreated(ApiVersionBean bean,
                                               ISecurityContext securityContext)

Creates an audit entry for the 'API version created' event.

Parameters:

bean - the bean

securityContext - the security context

Returns:

the audit entry

apiVersionUpdated

public static AuditEntryBean apiVersionUpdated(ApiVersionBean bean,
                                               EntityUpdatedData data,
                                               ISecurityContext securityContext)

Creates an audit entry for the 'API version updated' event.

Parameters:

bean - the bean

data - the updated data

securityContext - the security context

Returns:

the audit entry

apiDefinitionUpdated

public static AuditEntryBean apiDefinitionUpdated(ApiVersionBean bean,
                                                  ISecurityContext securityContext)

Creates an audit entry when a API definition is updated.

Parameters:

bean - the bean

securityContext - the security context

Returns:

the audit entry

apiDefinitionDeleted

public static AuditEntryBean apiDefinitionDeleted(ApiVersionBean bean,
                                                  ISecurityContext securityContext)

Creates an audit entry when a API definition is deleted.

Parameters:

bean - the bean

securityContext - the security context

Returns:

the audit entry

clientCreated

public static AuditEntryBean clientCreated(ClientBean bean,
                                           ISecurityContext securityContext)

Creates an audit entry for the 'client created' event.

Parameters:

bean - the bean

securityContext - the security context

Returns:

the audit entry

clientUpdated

public static AuditEntryBean clientUpdated(ClientBean bean,
                                           EntityUpdatedData data,
                                           ISecurityContext securityContext)

Creates an audit entry for the 'client updated' event.

Parameters:

bean - the bean

data - the updated data

securityContext - the security context

Returns:

the audit entry

clientVersionCreated

public static AuditEntryBean clientVersionCreated(ClientVersionBean bean,
                                                  ISecurityContext securityContext)

Creates an audit entry for the 'client version created' event.

Parameters:

bean - the bean

securityContext - the security context

Returns:

the audit entry

clientVersionUpdated

public static AuditEntryBean clientVersionUpdated(ClientVersionBean bean,
                                                  EntityUpdatedData data,
                                                  ISecurityContext securityContext)

Creates an audit entry for the 'client version updated' event.

Parameters:

bean - the bean

data - the updated data

securityContext - the security context

Returns:

the audit entry

contractCreatedFromClient

public static AuditEntryBean contractCreatedFromClient(ContractBean bean,
                                                       ISecurityContext securityContext)

Creates an audit entry for the 'contract created' event.

Parameters:

bean - the bean

securityContext - the security context

Returns:

the audit entry

contractCreatedToApi

public static AuditEntryBean contractCreatedToApi(ContractBean bean,
                                                  ISecurityContext securityContext)

Creates an audit entry for the 'contract created' event.

Parameters:

bean - the bean

securityContext - the security context

Returns:

the audit entry

contractBrokenFromClient

public static AuditEntryBean contractBrokenFromClient(ContractBean bean,
                                                      ISecurityContext securityContext)

Creates an audit entry for the 'contract broken' event.

Parameters:

bean - the bean

securityContext - the security context

Returns:

the audit entry

contractBrokenToApi

public static AuditEntryBean contractBrokenToApi(ContractBean bean,
                                                 ISecurityContext securityContext)

Creates an audit entry for the 'contract broken' event.

Parameters:

bean - the bean

securityContext - the security context

Returns:

the audit entry

policyAdded

public static AuditEntryBean policyAdded(PolicyBean bean,
                                         PolicyType type,
                                         ISecurityContext securityContext)

Creates an audit entry for the 'policy added' event. Works for all three kinds of policies.

Parameters:

bean - the bean

type - the policy type

securityContext - the security context

Returns:

the audit entry

policyRemoved

public static AuditEntryBean policyRemoved(PolicyBean bean,
                                           PolicyType type,
                                           ISecurityContext securityContext)

Creates an audit entry for the 'policy removed' event. Works for all three kinds of policies.

Parameters:

bean - the bean

type - the policy type

securityContext - the security context

Returns:

the audit entry

policyUpdated

public static AuditEntryBean policyUpdated(PolicyBean bean,
                                           PolicyType type,
                                           ISecurityContext securityContext)

Creates an audit entry for the 'policy updated' event. Works for all three kinds of policies.

Parameters:

bean - the bean

type - the policy type

securityContext - the security context

Returns:

the audit entry

planCreated

public static AuditEntryBean planCreated(PlanBean bean,
                                         ISecurityContext securityContext)

Creates an audit entry for the 'plan created' event.

Parameters:

bean - the bean

securityContext - the security context

Returns:

the audit entry

planUpdated

public static AuditEntryBean planUpdated(PlanBean bean,
                                         EntityUpdatedData data,
                                         ISecurityContext securityContext)

Creates an audit entry for the 'plan updated' event.

Parameters:

bean - the bean

data - the updated data

securityContext - the security context

Returns:

the audit entry

planVersionCreated

public static AuditEntryBean planVersionCreated(PlanVersionBean bean,
                                                ISecurityContext securityContext)

Creates an audit entry for the 'plan version created' event.

Parameters:

bean - the bean

securityContext - the security context

Returns:

the audit entry

planVersionUpdated

public static AuditEntryBean planVersionUpdated(PlanVersionBean bean,
                                                EntityUpdatedData data,
                                                ISecurityContext securityContext)

Creates an audit entry for the 'plan version updated' event.

Parameters:

bean - the bean

data - the updated data

securityContext - the security context

Returns:

the audit entry

apiPublished

public static AuditEntryBean apiPublished(ApiVersionBean bean,
                                          ISecurityContext securityContext)

Creates an audit entry for the 'API published' event.

Parameters:

bean - the bean

securityContext - the security context

Returns:

the audit entry

apiRetired

public static AuditEntryBean apiRetired(ApiVersionBean bean,
                                        ISecurityContext securityContext)

Creates an audit entry for the 'API retired' event.

Parameters:

bean - the bean

securityContext - the security context

Returns:

the audit entry

clientRegistered

public static AuditEntryBean clientRegistered(ClientVersionBean bean,
                                              ISecurityContext securityContext)

Creates an audit entry for the 'client registered' event.

Parameters:

bean - the bean

securityContext - the security context

Returns:

the audit entry

clientUnregistered

public static AuditEntryBean clientUnregistered(ClientVersionBean bean,
                                                ISecurityContext securityContext)

Creates an audit entry for the 'client unregistered' event.

Parameters:

bean - the bean

securityContext - the security context

Returns:

the audit entry

planLocked

public static AuditEntryBean planLocked(PlanVersionBean bean,
                                        ISecurityContext securityContext)

Creates an audit entry for the 'plan locked' event.

Parameters:

bean - the bean

securityContext - the security context

Returns:

the audit entry

policiesReordered

public static AuditEntryBean policiesReordered(ApiVersionBean apiVersion,
                                               PolicyType policyType,
                                               ISecurityContext securityContext)

Called when the user reorders the policies in a API.

Parameters:

apiVersion - the API version

policyType - the policy type

securityContext - the security context

Returns:

the audit entry

policiesReordered

public static AuditEntryBean policiesReordered(ClientVersionBean cvb,
                                               PolicyType policyType,
                                               ISecurityContext securityContext)

Called when the user reorders the policies in an client.

Parameters:

cvb - the client and version

policyType - the policy type

securityContext - the security context

Returns:

the audit entry

policiesReordered

public static AuditEntryBean policiesReordered(PlanVersionBean pvb,
                                               PolicyType policyType,
                                               ISecurityContext securityContext)

Called when the user reorders the policies in a plan.

Parameters:

pvb - the plan and version

policyType - the policy type

securityContext - the security context

Returns:

the audit entry

asString_ApiPlanBeans

public static String asString_ApiPlanBeans(Set<ApiPlanBean> plans)

Converts the list of plans to a string for display/comparison.

Parameters:

plans - the plans

Returns:

the plans as a string

asString_ApiGatewayBeans

public static String asString_ApiGatewayBeans(Set<ApiGatewayBean> gateways)

Converts the list of gateways to a string for display/comparison.

Parameters:

gateways - set of gateways

Returns:

the gateways as a string