|
Oracle Fusion Middleware Java API Reference for Oracle PDK Java 11g Release 1 (11.1.1) E10691-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.portal.provider.v2.cache.invalidation.InvalidationContext
public abstract class InvalidationContext
Interface for objects representing an invalidation object. It is used to
set up and execute an invalidation request. This is done by setting up an
InvalidationContext
type object and then building up
the invalidation request by setting various cache keys.
There are two sets of methods. The first allows requests to be set up from within the context of a provider (using JPDK objects). The second set enables external code to set up requests using object ids and names. NOTE: The set methods in this interface do not accept null values
Constructor Summary | |
---|---|
InvalidationContext()
|
Method Summary | |
---|---|
abstract void |
clearAllKeys()
Clear all of the cache keys so that an object of this type can be used to make repeated invalidation requests. |
abstract int |
invalidate()
Execute the invalidation. |
int |
invalidateURI(java.lang.String uriHost,
java.lang.String uriPrefix,
java.lang.String uriExpression)
Invalidates cached documents using an arbitrary host, port, folder prefix and regular expression suffix. |
abstract void |
setAuthenticationLevel(int level)
Set authentication level as an invalidation request key |
void |
setLocale(java.util.Locale locale)
Set locale as an invalidation key. |
abstract void |
setPortalRealm(PortalRealm pr)
Set the user's realm name as an invalidation key |
abstract void |
setPortalRealm(java.lang.String name)
Set the user's realm name as an invalidation key |
abstract void |
setPortlet(long id)
Set a portlet id for this invalidation request. |
abstract void |
setPortlet(PortletInstance pt)
Use a Portlet object to set up an invalidation request. |
void |
setPortletInstance(PortletInstance pInst)
Use a PortletInstance |
abstract void |
setPortletInstanceName(java.lang.String instanceName)
Set a portlet instance as key for an invalidation request. |
abstract void |
setPortletReference(PortletReference pRef)
Invalidate content using a PortletReference object. |
abstract void |
setProvider(ProviderInstance pr)
Use a Provider object to set up an invalidation request. |
abstract void |
setProvider(java.lang.String id)
Set a provider id for this invalidation request. |
abstract void |
setProviderSubscription(ProviderSubscription ps)
Set the subscription id as an invalidation key |
abstract void |
setProviderSubscription(java.lang.String id)
Set the subscription id as an invalidation key |
abstract void |
setService(java.lang.String id)
Set a service id for this invalidation request. |
abstract void |
setUser(ProviderUser pu)
Use a provider user as a key for the invalidation request. |
abstract void |
setUsername(java.lang.String user)
Set the user name as a key for the invalidation request |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public InvalidationContext()
Method Detail |
---|
public abstract void setProvider(ProviderInstance pr) throws InvalidationException
Provider
object to set up an invalidation request.
pr
- the provider whose content will be invalidated
InvalidationException
- thrown if a null parameter is passedpublic abstract void setPortlet(PortletInstance pt) throws InvalidationException
Portlet
object to set up an invalidation request. The
underlying implementation class should use Provider
info as
well as Portlet
info in the invalidation request.
pt
- portlet whose content will be invalidated
InvalidationException
- thrown if a null parameter is passedpublic void setPortletInstance(PortletInstance pInst) throws InvalidationException
PortletInstance as a key for an invalidation request.
The default implementation is included so that implementation classes
built against previous versions of the interface still work.
- Parameters:
pInst
- the object from which invalidation keys will be generated.
- Throws:
InvalidationException
- thrown if a null parameter is passed
public abstract void setPortletReference(PortletReference pRef) throws InvalidationException
PortletReference
object. This object
encapsulates the provider, portlet, portlet instance name, user name and
language.
pRef
- the portlet reference whose content will be invalidated
InvalidationException
- thrown if a null parameter is passedpublic abstract void setUser(ProviderUser pu) throws InvalidationException
pu
- the provider user object.
InvalidationException
- thrown if a null parameter is passedpublic abstract void setProviderSubscription(ProviderSubscription ps) throws InvalidationException
ps
- the JPDK object containing the invalidation key
InvalidationException
- thrown if a null parameter is passedpublic abstract void setProviderSubscription(java.lang.String id) throws InvalidationException
id
- the invalidation key
InvalidationException
- thrown if a null parameter is passedpublic abstract void setPortalRealm(PortalRealm pr) throws InvalidationException
pr
- the JPDK object containing the invalidation key
InvalidationException
- thrown if a null parameter is passedpublic abstract void setPortalRealm(java.lang.String name) throws InvalidationException
name
- the realm name
InvalidationException
- thrown if a null parameter is passedpublic abstract void setService(java.lang.String id) throws InvalidationException
id
- the id of the service whose content will be invalidated
InvalidationException
- thrown if a null parameter is passedpublic abstract void setProvider(java.lang.String id) throws InvalidationException
id
- the id of the provider whose content will be invalidated
InvalidationException
- thrown if a null parameter is passedpublic abstract void setPortlet(long id) throws InvalidationException
id
- the id of the portlet whose content will be invalidated
InvalidationException
- thrown if a null parameter is passedpublic abstract void setUsername(java.lang.String user) throws InvalidationException
user
- the provider user name
InvalidationException
- thrown if a null parameter is passedpublic abstract void setPortletInstanceName(java.lang.String instanceName) throws InvalidationException
instanceName
- the name of the portlet instance whose content
will be invalidated.
InvalidationException
- thrown if a null parameter is passedpublic abstract void setAuthenticationLevel(int level)
level
- the authentication level, e.g 1public void setLocale(java.util.Locale locale) throws InvalidationException
locale
- the locale object to be used as an invalidation key
InvalidationException
- thrown if null parameter is passed or
the method is not defined in the implementation classpublic abstract void clearAllKeys()
public abstract int invalidate() throws InvalidationException
InvalidationException
- throw if there is a problem during
invalidationpublic int invalidateURI(java.lang.String uriHost, java.lang.String uriPrefix, java.lang.String uriExpression) throws InvalidationException
Use this method to invalidate an arbitrary URI that has been cached.
Use this method to invalidate an arbitrary URI that has been cached.
Example usages:
int numInvalidations = invalidationContext.invalidateURI( "myhost.us.oracle.com:7777", "/public/documents/jsp/", "info\\.jsp");
int numInvalidations = invalidationContext.invalidateURI( "myhost.us.oracle.com:7777", "/public/documents/jsp/", "info.*jsp");
uriHost
- the host and port of the document(s) to be invalidated.
Must have the format "hostname:port".uriPrefix
- the folder that prefixes the document(s).
Must have the format "/folder1/.../folderN/".
Note that there must be opening and closing '/' slashes.uriExpression
- a
regular expression corresponding to the URL of the
document(s) to be invalidated underneath the uriPrefix
InvalidationException
- if there is a problem during
invalidation
|
Oracle Fusion Middleware Java API Reference for Oracle PDK Java 11g Release 1 (11.1.1) E10691-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |