com.bea.wli.config.task.impl

Class GetDependenciesSearchTask

java.lang.Object

com.bea.wli.config.task.impl.SessionedTask<java.util.Set<Ref>>

com.bea.wli.config.task.impl.GetDependenciesSearchTask

All Implemented Interfaces:

java.util.concurrent.Callable<java.util.Set<Ref>>

public class GetDependenciesSearchTask
extends SessionedTask<java.util.Set<Ref>>

This task searches dependencies recursively for a given ref.

Only dependencies matching the given set of ids are returned. Optionnally, one can define a set of type ids for which the search should stop. Refs are returned in the deletion order.

Constructor Summary

Constructors

Constructor and Description
GetDependenciesSearchTask(Ref ref, java.util.Set<java.lang.String> typeIds, java.util.Set<java.lang.String> frontierTypeIds, boolean includeMissingRefs) constructor

Method Summary

Modifier and Type	Method and Description
protected java.util.Set<Ref>	_execute() Subclasses implement this method
static java.util.Set<Ref>	getDependencies(ConfigService configService, Ref ref, java.util.Set<java.lang.String> typeIds, java.util.Set<java.lang.String> frontierTypeIds) convenience method (does not include missing refs by default)
static java.util.Set<Ref>	getDependencies(ConfigService configService, Ref ref, java.util.Set<java.lang.String> typeIds, java.util.Set<java.lang.String> frontierTypeIds, boolean includeMissingRefs) convenience method
static java.util.Set<Ref>	getDependencies(ConfigService configService, java.lang.String session, Ref ref, java.util.Set<java.lang.String> typeIds, java.util.Set<java.lang.String> frontierTypeIds) convenience method (does not include missing refs by default)
static java.util.Set<Ref>	getDependencies(ConfigService configService, java.lang.String session, Ref ref, java.util.Set<java.lang.String> typeIds, java.util.Set<java.lang.String> frontierTypeIds, boolean includeMissingRefs) convenience method

Methods inherited from class com.bea.wli.config.task.impl.SessionedTask

assertExists, assertLocation, assertNONResource, assertNotExists, assertNotLocationData, assertNotNull, assertNotNullElement, assertResource, assertSimple, call, doExecute, doExecute, doExecute, doExecute, expand, getConfigContext, getConfigMBean, getConfigService, getDescription, getSession, isLocation, isReadOnlyTransaction, requiresSystemTransaction

Methods inherited from class java.lang.Object

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

Constructor Detail

GetDependenciesSearchTask

public GetDependenciesSearchTask(Ref ref,
                                 java.util.Set<java.lang.String> typeIds,
                                 java.util.Set<java.lang.String> frontierTypeIds,
                                 boolean includeMissingRefs)

constructor

Parameters:

ref - the ref to start from . This reference must exist

typeIds - types of referenes to consider. If null, consider all types of references

frontierTypeIds - indicates when to stop recursing (searching) along an edge. If non-null, and if recursing along an edge from Node A to Node B, the search stops along that edge stops after processing B. In other words there will be no recursing from Node B to its ascendands/descendants. If the value is null, the search does not stop based on the node type.

includeMissingRefs - whether to include a reference in the result set even if it does not exist. This argument is ignored when isAncestor is true. When collecting ancestors all the ancestors that are found are guaranteed to exist because we are recursing from children up to the parents.

Method Detail

getDependencies

public static java.util.Set<Ref> getDependencies(ConfigService configService,
                                                 Ref ref,
                                                 java.util.Set<java.lang.String> typeIds,
                                                 java.util.Set<java.lang.String> frontierTypeIds)
                                          throws NotFoundException

convenience method (does not include missing refs by default)

Throws:

NotFoundException

getDependencies

public static java.util.Set<Ref> getDependencies(ConfigService configService,
                                                 java.lang.String session,
                                                 Ref ref,
                                                 java.util.Set<java.lang.String> typeIds,
                                                 java.util.Set<java.lang.String> frontierTypeIds)
                                          throws NotFoundException

convenience method (does not include missing refs by default)

Throws:

NotFoundException

getDependencies

public static java.util.Set<Ref> getDependencies(ConfigService configService,
                                                 Ref ref,
                                                 java.util.Set<java.lang.String> typeIds,
                                                 java.util.Set<java.lang.String> frontierTypeIds,
                                                 boolean includeMissingRefs)
                                          throws NotFoundException

convenience method

Throws:

NotFoundException

getDependencies

public static java.util.Set<Ref> getDependencies(ConfigService configService,
                                                 java.lang.String session,
                                                 Ref ref,
                                                 java.util.Set<java.lang.String> typeIds,
                                                 java.util.Set<java.lang.String> frontierTypeIds,
                                                 boolean includeMissingRefs)
                                          throws NotFoundException

convenience method

Throws:

NotFoundException

_execute

protected java.util.Set<Ref> _execute()
                               throws NotFoundException

Description copied from class: SessionedTask

Subclasses implement this method

Specified by:

_execute in class SessionedTask<java.util.Set<Ref>>

Returns:

the result of the execution

Throws:

NotFoundException