com.ibm.wsspi.security.registry
Class RegistryHelper

java.lang.Object
  extended by com.ibm.wsspi.security.registry.RegistryHelper

public class RegistryHelper
extends java.lang.Object

Provides methods to retrieve user registry information

Since:
WAS 7.0

Constructor Summary
RegistryHelper()
           
 
Method Summary
 void activate(org.osgi.service.component.ComponentContext cc)
           
 void deactivate(org.osgi.service.component.ComponentContext cc)
           
static java.util.List<java.lang.String> getInboundTrustedRealms(java.lang.String realmName)
           The getInboundTrustedRealms method returns the list of inbound trusted realms corresponding to the active user registry that matches this realm.
static UserRegistry getUserRegistry(java.lang.String realmName)
          Gets the UserRegistry object for the given realm.
static boolean isRealmInboundTrusted(java.lang.String inboundRealm, java.lang.String localRealm)
          Determine if the inbound realm is one of the trusted realms of the specified local realm.
 void setWsSecurityService(org.osgi.framework.ServiceReference<com.ibm.ws.security.intfc.WSSecurityService> reference)
           
 void unsetWsSecurityService(org.osgi.framework.ServiceReference<com.ibm.ws.security.intfc.WSSecurityService> reference)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RegistryHelper

public RegistryHelper()
Method Detail

setWsSecurityService

public void setWsSecurityService(org.osgi.framework.ServiceReference<com.ibm.ws.security.intfc.WSSecurityService> reference)

unsetWsSecurityService

public void unsetWsSecurityService(org.osgi.framework.ServiceReference<com.ibm.ws.security.intfc.WSSecurityService> reference)

activate

public void activate(org.osgi.service.component.ComponentContext cc)

deactivate

public void deactivate(org.osgi.service.component.ComponentContext cc)

getUserRegistry

public static UserRegistry getUserRegistry(java.lang.String realmName)
                                    throws WSSecurityException
Gets the UserRegistry object for the given realm. If the realm name is null returns the active registry. If the realm is not valid, or security is not enabled, or no registry is configured, returns null.

Parameters:
realmName -
Returns:
UserRegistry object
Throws:
WSSecurityException - if there is an internal error

getInboundTrustedRealms

public static java.util.List<java.lang.String> getInboundTrustedRealms(java.lang.String realmName)
                                                                throws WSSecurityException

The getInboundTrustedRealms method returns the list of inbound trusted realms corresponding to the active user registry that matches this realm. If the realm is null, it returns the inbound trusted realms for the realm (user registry) based on the thread context. The realm should be available in the process being called. If the process does not host this realm, it will return an empty list. If all realms are trusted, it will return "*" in the List This method requires that the realm names are unique.

Parameters:
String - (the realm name - null implies context based realm)
Returns:
java.util.List of trusted realms
Throws:
WSSecurityException

isRealmInboundTrusted

public static boolean isRealmInboundTrusted(java.lang.String inboundRealm,
                                            java.lang.String localRealm)
Determine if the inbound realm is one of the trusted realms of the specified local realm. If the local realm is null the realm of the current active user registry will be used.

Parameters:
inboundRealm -
localRealm -
Returns:
true - inbound realm is trusted, false - inbound reamn is not trusted