com.webmethods.portal.mech.alias

Interface IAliasMechanics

All Superinterfaces:

IComponent, IInitializable, IMechanics, ISystemHandler

All Known Subinterfaces:

ITopicSpaceMechanics

public interface IAliasMechanics
extends IMechanics

This mechanics interacts with alias caches and values.

See Also:

for details

Method Summary

Modifier and Type	Method and Description
boolean	canCreateAlias(IThingID userID, IURI key) returns true if the user can create an alias with that value
boolean	canCreateAliasKey(IThingID userID, String key) returns true if the user can create an alias with that value
boolean	canRemoveAlias(IThingID userID, IURI key) returns true if you can remove this alias
boolean	canRemoveAlias(IThingID userID, String key) returns true if you can remove this alias
void	checkCreateAlias(IThingID userID, IURI key)
void	checkCreateAliasKey(IThingID userID, String key)
void	checkRemoveAlias(IThingID userID, IURI key)
void	checkRemoveAlias(IThingID userID, String key)
void	createAlias(IURI key, IURI value, boolean isSystem) Creates a simple IAliasValue
void	createAlias(IURI key, IURI value, String params, boolean isSystem) Creates a simple AliasValue
void	createAlias(IURI key, String value, String params, boolean isSystem) Creates a simple IAliasValue
void	createAlias(String key, IURI value, boolean isSystem) Creates a simple IAliasValue
void	createAlias(String key, IURI value, String params, boolean isSystem) Creates a simple IAliasValue
void	createAlias(String key, String value, boolean isSystem) Creates a simple IAliasValue
void	createAlias(String key, String value, String params, boolean isSystem) Creates a simple IAliasValue
void	fireAliasCreateEvent(IThingID userID, Object key, Object value, boolean isSystem) Fires alias create event
void	fireAliasRemoveEvent(IThingID userID, Object key) Fires alias remove event
IAliasValue	lookupAlias(IURI key) Retrieve the appropriate IAliasValue based on a simple key
IAliasValue	lookupAlias(String key) Retrieve the appropriate IAliasValue based on a simple key
Collection<ICacheEntry>	lookupAliasKeys() Returns all AliasKeys
Collection<IAliasKey>	lookupAliasKeys(IURI value) Returns a list of keys that have this value
Collection<IAliasKey>	lookupAliasKeys(String value) Returns a list of keys that have this value
void	reloadAliasCache() Reload alias cache
void	removeAlias(IURI key) Removes an alias
void	removeAlias(String key) Removes an alias

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 Detail

lookupAlias

IAliasValue lookupAlias(String key)

Retrieve the appropriate IAliasValue based on a simple key

Parameters:

key - an arbitary key

Returns:

the IAliasValue if found, NULL otherwise

lookupAlias

IAliasValue lookupAlias(IURI key)

Retrieve the appropriate IAliasValue based on a simple key

Parameters:

key - an arbitary key (could also be a IThingID

Returns:

the IAliasValue if found, NULL otherwise

createAlias

void createAlias(String key,
                 String value,
                 boolean isSystem)

Creates a simple IAliasValue

Parameters:

key - the alias identifier

value - the target of the alias

isSystem - whether this is a protected system alias

createAlias

void createAlias(String key,
                 String value,
                 String params,
                 boolean isSystem)

Creates a simple IAliasValue

Parameters:

key - the alias identifier

value - the target of the alias

params - extra params to append

isSystem - whether this is a protected system alias

createAlias

void createAlias(String key,
                 IURI value,
                 boolean isSystem)

Creates a simple IAliasValue

Parameters:

key - the alias identifier

value - the target of the alias (could also be a IThingID

isSystem - whether this is a protected system alias

createAlias

void createAlias(String key,
                 IURI value,
                 String params,
                 boolean isSystem)

Creates a simple IAliasValue

Parameters:

key - the alias identifier

value - the target of the alias (could also be a IThingID

params - extra params to append

isSystem - whether this is a protected system alias

createAlias

void createAlias(IURI key,
                 String value,
                 String params,
                 boolean isSystem)

Creates a simple IAliasValue

Parameters:

key - the alias identifier

value - the target of the alias

params - extra params to append

isSystem - whether this is a protected system alias

createAlias

void createAlias(IURI key,
                 IURI value,
                 boolean isSystem)

Creates a simple IAliasValue

Parameters:

key - the alias identifier (could also be a IThingID

value - the target of the alias (could also be a IThingID

isSystem - whether this is a protected system alias

createAlias

void createAlias(IURI key,
                 IURI value,
                 String params,
                 boolean isSystem)

Creates a simple AliasValue

Parameters:

key - the alias identifier (could also be a IThingID

value - the target of the alias (could also be a IThingID

params - extra params to append

isSystem - whether this is a protected system alias

removeAlias

void removeAlias(String key)

Removes an alias

Parameters:

key - like used in lookupAlias(java.lang.String)

removeAlias

void removeAlias(IURI key)

Removes an alias

Parameters:

key - like used in lookupAlias(java.lang.String)

lookupAliasKeys

Collection<ICacheEntry> lookupAliasKeys()

Returns all AliasKeys

Returns:

lookupAliasKeys

Collection<IAliasKey> lookupAliasKeys(String value)

Returns a list of keys that have this value

Parameters:

value - the target destination of the alias

Returns:

a list of IAliasKeys that contain the keys. Maybe empty

lookupAliasKeys

Collection<IAliasKey> lookupAliasKeys(IURI value)

Returns a list of keys that have this value

Parameters:

value - the target destination of the alias

Returns:

a list of IAliasKeys that contain the keys. Maybe empty

canCreateAliasKey

boolean canCreateAliasKey(IThingID userID,
                          String key)
                   throws PortalException

returns true if the user can create an alias with that value

Parameters:

userID - the current user

key - alias key

Throws:

PortalException

checkCreateAliasKey

void checkCreateAliasKey(IThingID userID,
                         String key)
                  throws PortalException,
                         PortalAccessException

Throws:

PortalException

PortalAccessException

See Also:

canCreateAliasKey(com.webmethods.portal.service.meta2.thing.IThingID, java.lang.String)

canCreateAlias

boolean canCreateAlias(IThingID userID,
                       IURI key)
                throws PortalException

returns true if the user can create an alias with that value

Parameters:

userID - the current user

key - only checked if a IThingID

Throws:

PortalException

checkCreateAlias

void checkCreateAlias(IThingID userID,
                      IURI key)
               throws PortalException,
                      PortalAccessException

Throws:

PortalException

PortalAccessException

See Also:

canCreateAlias(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.system.IURI)

canRemoveAlias

boolean canRemoveAlias(IThingID userID,
                       IURI key)
                throws PortalException

returns true if you can remove this alias

Parameters:

userID -

key - only check if a IThingID

Returns:

Throws:

PortalException

checkRemoveAlias

void checkRemoveAlias(IThingID userID,
                      IURI key)
               throws PortalException,
                      PortalAccessException

Throws:

PortalException

PortalAccessException

See Also:

canRemoveAlias(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.system.IURI)

canRemoveAlias

boolean canRemoveAlias(IThingID userID,
                       String key)
                throws PortalException

returns true if you can remove this alias

Parameters:

userID -

key - only check if a IThingID

Returns:

Throws:

PortalException

checkRemoveAlias

void checkRemoveAlias(IThingID userID,
                      String key)
               throws PortalException,
                      PortalAccessException

Throws:

PortalException

PortalAccessException

See Also:

canRemoveAlias(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.system.IURI)

fireAliasCreateEvent

void fireAliasCreateEvent(IThingID userID,
                          Object key,
                          Object value,
                          boolean isSystem)
                   throws PortalException

Fires alias create event

Throws:

PortalException

fireAliasRemoveEvent

void fireAliasRemoveEvent(IThingID userID,
                          Object key)
                   throws PortalException

Fires alias remove event

Throws:

PortalException

reloadAliasCache

void reloadAliasCache()
               throws PortalException

Reload alias cache

Throws:

PortalException