Package com.webmethods.portal.bizPolicy.biz.alias

Interface IAliasPolicy2

All Superinterfaces:

IBizPolicy, IComponent, IInitializable, ISystemHandler

public interface IAliasPolicy2
extends IBizPolicy

Method Summary

Modifier and Type	Method	Description
void	createAlias(IContext context, String key, IURI target, boolean isSystem)	This will create a new alias.
String[]	listAliases(IContext context, IURI target)	Returns an array of all the aliases that exist for this target
IAliasValue	lookupAlias(IContext context, String key)	Retrieve the appropriate AliasValue based on a simple key.
void	removeAlias(IContext context, String key)	Removes an alias previously created.

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Method Details

createAlias

void createAlias(IContext context,
 String key,
 IURI target,
 boolean isSystem)
          throws BizException

This will create a new alias. The source key is what will be passed in to subsequent calls to lookupAlias(com.webmethods.portal.bizPolicy.IContext, java.lang.String) to retrieve the AliasValue which will represent the target.

IsSystem specifies extra restrictions placed upon this alias. If this is set to true, then this alias can not be removed through the alias administration portlet, and will require an administrator invoking apis directly to remove this alias.

Parameters:

context - Command context (user state information).

isSystem - whether this is a protected system alias

Throws:

BizException

See Also:

• IAliasCache
• AliasValue

lookupAlias

IAliasValue lookupAlias(IContext context,
 String key)
                 throws BizException

Retrieve the appropriate AliasValue based on a simple key. The key is 'object' passed in from a previous call to createAlias(com.webmethods.portal.bizPolicy.IContext, java.lang.String, com.webmethods.portal.system.IURI, boolean). If an alias is found, you can get the 'target' by calling AliasValue#getValue. Other information is also available on the AliasValue.

Parameters:

context - Command context (user state information).

key - an arbitary key that may be a IURI or a String

Returns:

the AliasValue if found, NULL otherwise

Throws:

BizException

listAliases

String[] listAliases(IContext context,
 IURI target)
              throws BizException

Returns an array of all the aliases that exist for this target

Parameters:

context - Command context (user state information).

Throws:

BizException

removeAlias

void removeAlias(IContext context,
 String key)
          throws BizException

Removes an alias previously created. The key is 'object' passed in from a previous call to createAlias(com.webmethods.portal.bizPolicy.IContext, java.lang.String, com.webmethods.portal.system.IURI, boolean). Note, if this alias was created as a 'system' alias, then you will not have access rights to remove it, unless you first disable the ITraits on the IContext.

Parameters:

context - Command context (user state information).

key - an arbitary key that may be a IURI or a String

Throws:

BizException