Java EE 5 SDK

com.sun.appserv.management.helper
Class RefHelper

java.lang.Object
  extended by com.sun.appserv.management.helper.RefHelper

public class RefHelper
extends Object

Helper routines for references. This class should only be used in EE builds.

Since:
AppServer 9.0

Method Summary
static Set<ClusterRefConfig> findAllClusterRefConfigs(QueryMgr queryMgr)
          Find all ClusterRefConfig.
static Set<DeployedItemRefConfig> findAllDeployedItemRefConfigs(QueryMgr queryMgr)
          Find all DeployedItemRefConfig.
static Set<ClusterRefConfig> findAllRefConfigs(ClusterRefConfigReferent referent)
          Find all ClusterRefConfig that reference the specified item.
static Set<DeployedItemRefConfig> findAllRefConfigs(DeployedItemRefConfigReferent referent)
          Find all DeployedItemRefConfig that reference the specified item.
static
<T extends RefConfig>
Set<T>
findAllRefConfigs(QueryMgr queryMgr)
          Find all ref configs of any j2EEType
static
<T extends RefConfig>
Set<T>
findAllRefConfigs(RefConfigReferent referent)
          Find all RefConfig that reference the specified j2eeType/name combo.
static
<T extends RefConfig>
Set<T>
findAllRefConfigs(RefConfigReferent referent, String refJ2EEType)
          Find all RefConfig that reference the specified j2eeType/name combo.
static Set<ResourceRefConfig> findAllRefConfigs(ResourceRefConfigReferent referent)
          Find all ResourceRefConfig that reference the specified item.
static Set<ServerRefConfig> findAllRefConfigs(ServerRefConfigReferent referent)
          Find all ServerRefConfig that reference the specified item.
static
<T extends RefConfig>
Set<T>
findAllRefConfigsByJ2EEType(QueryMgr queryMgr, String refJ2EEType)
          Find all ref configs of the specified j2EEType
static
<T extends RefConfig>
Set<T>
findAllRefConfigsWithName(QueryMgr queryMgr, String refJ2EEType, String name)
          Find all RefConfig of the specified j2EEType having the specified name.
static Set<ResourceRefConfig> findAllResourceRefConfigs(QueryMgr queryMgr)
          Find all ResourceRefConfig.
static Set<ServerRefConfig> findAllServerRefConfigs(QueryMgr queryMgr)
          Find all ServerRefConfig.
static Set<String> getReferentJ2EETypes()
           
static String getReferentRefJ2EEType(RefConfigReferent referent)
           
static
<T extends RefConfig>
Set<T>
removeAllRefsTo(RefConfigReferent item, boolean allowSingleFailure)
           
static
<T extends RefConfig>
Set<T>
removeRefConfigs(Set<T> refs)
          Remove all specified references (that are possible).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

findAllRefConfigs

public static <T extends RefConfig> Set<T> findAllRefConfigs(QueryMgr queryMgr)
Find all ref configs of any j2EEType

Returns:
Set of all RefConfig found.

findAllRefConfigsByJ2EEType

public static <T extends RefConfig> Set<T> findAllRefConfigsByJ2EEType(QueryMgr queryMgr,
                                                                       String refJ2EEType)
Find all ref configs of the specified j2EEType

Returns:
Set of all RefConfig found.

findAllResourceRefConfigs

public static Set<ResourceRefConfig> findAllResourceRefConfigs(QueryMgr queryMgr)
Find all ResourceRefConfig.

Returns:
Set of all ResourceRefConfig found.

findAllDeployedItemRefConfigs

public static Set<DeployedItemRefConfig> findAllDeployedItemRefConfigs(QueryMgr queryMgr)
Find all DeployedItemRefConfig.

Returns:
Set of all DeployedItemRefConfig found.

findAllServerRefConfigs

public static Set<ServerRefConfig> findAllServerRefConfigs(QueryMgr queryMgr)
Find all ServerRefConfig.

Returns:
Set of all ServerRefConfig found.

findAllClusterRefConfigs

public static Set<ClusterRefConfig> findAllClusterRefConfigs(QueryMgr queryMgr)
Find all ClusterRefConfig.

Returns:
Set of all ClusterRefConfig found.

findAllRefConfigsWithName

public static <T extends RefConfig> Set<T> findAllRefConfigsWithName(QueryMgr queryMgr,
                                                                     String refJ2EEType,
                                                                     String name)
Find all RefConfig of the specified j2EEType having the specified name.

Returns:
Set of all RefConfig found with the specified name.

getReferentRefJ2EEType

public static String getReferentRefJ2EEType(RefConfigReferent referent)
Returns:
the j2eeType of the config element which can refer to this item

getReferentJ2EETypes

public static Set<String> getReferentJ2EETypes()

findAllRefConfigs

public static <T extends RefConfig> Set<T> findAllRefConfigs(RefConfigReferent referent)
Find all RefConfig that reference the specified j2eeType/name combo.


findAllRefConfigs

public static <T extends RefConfig> Set<T> findAllRefConfigs(RefConfigReferent referent,
                                                             String refJ2EEType)
Find all RefConfig that reference the specified j2eeType/name combo.


findAllRefConfigs

public static Set<DeployedItemRefConfig> findAllRefConfigs(DeployedItemRefConfigReferent referent)
Find all DeployedItemRefConfig that reference the specified item.


findAllRefConfigs

public static Set<ResourceRefConfig> findAllRefConfigs(ResourceRefConfigReferent referent)
Find all ResourceRefConfig that reference the specified item.


findAllRefConfigs

public static Set<ServerRefConfig> findAllRefConfigs(ServerRefConfigReferent referent)
Find all ServerRefConfig that reference the specified item.


findAllRefConfigs

public static Set<ClusterRefConfig> findAllRefConfigs(ClusterRefConfigReferent referent)
Find all ClusterRefConfig that reference the specified item.


removeAllRefsTo

public static <T extends RefConfig> Set<T> removeAllRefsTo(RefConfigReferent item,
                                                           boolean allowSingleFailure)

removeRefConfigs

public static <T extends RefConfig> Set<T> removeRefConfigs(Set<T> refs)
Remove all specified references (that are possible).

Returns:
any references that could not be removed

Java EE 5 SDK

Submit a bug or feature

Copyright 2006 Sun Microsystems, Inc. All rights reserved.