Package com.opencloud.rhino.management.deployment.audit

Class ComponentAuditResult

java.lang.Object

com.opencloud.rhino.management.deployment.audit.ComponentAuditResult

All Implemented Interfaces:

Serializable

public final class ComponentAuditResult
extends Object
implements Serializable

This class contains the result of a component audit. A component audit is performed using the DeploymentMBean.auditComponent(ComponentID) method.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ComponentAuditResult()

Method Summary

Modifier and Type	Method	Description
void	addDuplicateClassReference(String component, String refType, String referencingClass, String referencedClass, Collection<List<String>> resolvePaths)	Add a duplicate class reference to the audit result.
void	addUnresolvedClassReference(String component, String refType, String referencingClass, String referencedClass)	Add an unresolved class reference to the audit result.
Collection<ComponentErrors>	getComponentErrors()	Get the collection of component errors reported by the audit.
boolean	isAuditSuccessful()	Determine if the component audit completed without any issues being found.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentAuditResult

public ComponentAuditResult()

Method Detail

isAuditSuccessful

public boolean isAuditSuccessful()

Determine if the component audit completed without any issues being found.

Returns:

true if the audit completed without any issues being found, false otherwise.

addUnresolvedClassReference

public void addUnresolvedClassReference(String component,
                                        String refType,
                                        String referencingClass,
                                        String referencedClass)

Add an unresolved class reference to the audit result.

Parameters:

component - the identifier of the component containing the reference to the unresolvable class. This could be the string format of a SLEE component identifier or the URL of a manifest classpath jar.

refType - a description of the type of reference. For example, a component jar, a manifest classpath jar, or a constituent library jar of a library component.

referencingClass - the name of the class that is the source of the reference.

referencedClass - the name of the referenced class.

addDuplicateClassReference

public void addDuplicateClassReference(String component,
                                       String refType,
                                       String referencingClass,
                                       String referencedClass,
                                       Collection<List<String>> resolvePaths)

Add a duplicate class reference to the audit result.

Parameters:

component - the identifier of the component containing the reference to the unresolvable class. This could be the string format of a SLEE component identifier or the URL of a manifest classpath jar.

refType - a description of the type of reference. For example, a component jar, a manifest classpath jar, or a constituent library jar of a library component.

referencingClass - the name of the class that is the source of the reference.

referencedClass - the name of the referenced class.

resolvePaths - a collection of the dependency graphs through which the referenced class can be resolved. Each String element is a description of a classloader that is a node in the dependency graph.

getComponentErrors

public Collection<ComponentErrors> getComponentErrors()

Get the collection of component errors reported by the audit.

Returns:

the reported component errors.