Index (WSO2 Carbon - Cache mediator 4.6.40 API)

A C D E G H I M O P R S T

A

ALL - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants: To represent all-values in certain places in the cache mediator
ANY_RESPONSE_CODE - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants: The regex for the 2xx response code.

C

CachableResponse - Class in org.wso2.carbon.mediator.cache: This object holds the cached response and the related properties of the cache per request and will be stored in to the cache.
CachableResponse() - Constructor for class org.wso2.carbon.mediator.cache.CachableResponse
CACHE_KEY - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants: The the header that would be used to return the hashed value to invalidate this value.
CACHE_LOCAL_NAME - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants: Local name of the cache mediator which will be used by the module.
CACHE_Q - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants: QName of the cache mediator which will be used by the module.
CACHED_OBJECT - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants: String key to store the cached response in the message context.
CacheMediator - Class in org.wso2.carbon.mediator.cache: If a request comes to this class it creates and hash of the request and if the hash has a CachedResponse associated with it the mediator will return the response without going to the backend.
CacheMediator() - Constructor for class org.wso2.carbon.mediator.cache.CacheMediator
CacheMediatorFactory - Class in org.wso2.carbon.mediator.cache: Creates a CacheMediator using the given OMElement for the cache mediator.
CacheMediatorFactory() - Constructor for class org.wso2.carbon.mediator.cache.CacheMediatorFactory
CacheMediatorSerializer - Class in org.wso2.carbon.mediator.cache: Serializes the given Cache mediator to an OMElement.
CacheMediatorSerializer() - Constructor for class org.wso2.carbon.mediator.cache.CacheMediatorSerializer
CachingConstants - Class in org.wso2.carbon.mediator.cache: This has the common constants used in the classes related to the cache mediator implementation.
CachingConstants() - Constructor for class org.wso2.carbon.mediator.cache.CachingConstants
CachingException - Exception in org.wso2.carbon.mediator.cache: This is the CachingException which is a checked exception and will be thrown in case of an error in the caching execution
CachingException() - Constructor for exception org.wso2.carbon.mediator.cache.CachingException: Default constructor of the CachingException
CachingException(String) - Constructor for exception org.wso2.carbon.mediator.cache.CachingException: This constructor of the CachingException sets the given String message to the Exception
CachingException(String, Throwable) - Constructor for exception org.wso2.carbon.mediator.cache.CachingException: This constructor of the CachingException sets the given String message, and the cause to the Exception
CachingException(Throwable) - Constructor for exception org.wso2.carbon.mediator.cache.CachingException: This constructor of the CachingException sets the given cause to the Exception
clean() - Method in class org.wso2.carbon.mediator.cache.CachableResponse: Sets the responsePayload and the headerProperties to null
COLLECTOR_STRING - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants
compareOMAttribute(OMAttribute, OMAttribute, String) - Method in class org.wso2.carbon.mediator.cache.digest.DOMHASHGenerator: Deprecated.

Compares two OMAttributes for the XML equality.
compareOMDocument(OMDocument, OMDocument, String) - Method in class org.wso2.carbon.mediator.cache.digest.DOMHASHGenerator: Deprecated.

Compares two OMDocuments for the XML equality.
compareOMNode(OMNode, OMNode, String) - Method in class org.wso2.carbon.mediator.cache.digest.DOMHASHGenerator: Deprecated.

Compares two OMNodes for the XML equality.
createSpecificMediator(OMElement, Properties) - Method in class org.wso2.carbon.mediator.cache.CacheMediatorFactory

D

DEFAULT_HASH_GENERATOR - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants: Default DigestGenerator for the caching impl.
DEFAULT_SIZE - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants: The default size for the maxSize and maxMessageSize
DEFAULT_TIMEOUT - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants: This holds the default timeout of the mediator cache.
destroy() - Method in class org.wso2.carbon.mediator.cache.CacheMediator
DigestGenerator - Interface in org.wso2.carbon.mediator.cache.digest: This is the primary interface for the DigestGenerator which is the unique SOAP request identifier generation interface to be used by the CacheManager inorder to generate a unique identifier key for the normalized XML/SOAP message.
DOMHASHGenerator - Class in org.wso2.carbon.mediator.cache.digest: Deprecated.
DOMHASHGenerator() - Constructor for class org.wso2.carbon.mediator.cache.digest.DOMHASHGenerator: Deprecated.

E

exposeInvalidator(MessageContext) - Method in class org.wso2.carbon.mediator.cache.CacheMediator: Exposes the whole mediator cache through jmx MBean.

G

getAttributesWithoutNS(OMElement) - Method in class org.wso2.carbon.mediator.cache.digest.DOMHASHGenerator: Deprecated.

Gets the collection of attributes which are none namespace declarations for an OMElement sorted according to the expanded names of the attributes.
getAttributesWithoutNS(OMElement) - Method in class org.wso2.carbon.mediator.cache.digest.HttpRequestHashGenerator: Gets the collection of attributes which are none namespace declarations for an OMElement sorted according to the expanded names of the attributes.
getDigest(MessageContext) - Method in interface org.wso2.carbon.mediator.cache.digest.DigestGenerator: This method will be implemented to return the unique XML node identifier on the given XML node
getDigest(MessageContext) - Method in class org.wso2.carbon.mediator.cache.digest.DOMHASHGenerator: Deprecated.

This is the implementation of the getDigest method and will implement the DOMHASH algorithm based XML node identifications.
getDigest(OMNode, String) - Method in class org.wso2.carbon.mediator.cache.digest.DOMHASHGenerator: Deprecated.

This is an overloaded method for the digest generation for OMNode.
getDigest(OMDocument, String) - Method in class org.wso2.carbon.mediator.cache.digest.DOMHASHGenerator: Deprecated.

This is an overloaded method for the digest generation for OMDocument.
getDigest(OMElement, String) - Method in class org.wso2.carbon.mediator.cache.digest.DOMHASHGenerator: Deprecated.

This is an overloaded method for the digest generation for OMElement.
getDigest(OMProcessingInstruction, String) - Method in class org.wso2.carbon.mediator.cache.digest.DOMHASHGenerator: Deprecated.

This method is an overloaded method for the digest generation for OMProcessingInstruction.
getDigest(OMAttribute, String) - Method in class org.wso2.carbon.mediator.cache.digest.DOMHASHGenerator: Deprecated.

This is an overloaded method for the digest generation for OMAttribute.
getDigest(OMText, String) - Method in class org.wso2.carbon.mediator.cache.digest.DOMHASHGenerator: Deprecated.

This method is an overloaded method for the digest generation for OMText.
getDigest(MessageContext) - Method in class org.wso2.carbon.mediator.cache.digest.HttpRequestHashGenerator: This method will be implemented to return the unique XML node identifier on the given XML node
getDigest(String, String) - Method in class org.wso2.carbon.mediator.cache.digest.HttpRequestHashGenerator: For the digest generation using the to address.
getDigest(OMNode, String) - Method in class org.wso2.carbon.mediator.cache.digest.HttpRequestHashGenerator: This is an overloaded method for the digest generation for OMNode.
getDigest(OMNode, String, Map<String, String>, String) - Method in class org.wso2.carbon.mediator.cache.digest.HttpRequestHashGenerator: This is an overloaded method for the digest generation for OMNode and request.
getDigest(String, String, String) - Method in class org.wso2.carbon.mediator.cache.digest.HttpRequestHashGenerator
getDigest(OMElement, String, Map<String, String>, String) - Method in class org.wso2.carbon.mediator.cache.digest.HttpRequestHashGenerator: This is an overloaded method for the digest generation for OMElement.
getDigest(OMText, String) - Method in class org.wso2.carbon.mediator.cache.digest.HttpRequestHashGenerator: This method is an overloaded method for the digest generation for OMText.
getDigest(OMProcessingInstruction, String) - Method in class org.wso2.carbon.mediator.cache.digest.HttpRequestHashGenerator: This method is an overloaded method for the digest generation for OMProcessingInstruction.
getDigest(OMAttribute, String) - Method in class org.wso2.carbon.mediator.cache.digest.HttpRequestHashGenerator: This is an overloaded method for the digest generation for OMAttribute.
getDigest(MessageContext) - Method in class org.wso2.carbon.mediator.cache.digest.REQUESTHASHGenerator: Deprecated.

This is the implementation of the getDigest method and will implement the Extended DOMHASH algorithm based HTTP request identifications.
getDigest(OMNode, String, Map<String, String>, String) - Method in class org.wso2.carbon.mediator.cache.digest.REQUESTHASHGenerator: Deprecated.

This is an overloaded method for the digest generation for OMNode and request.
getDigest(OMElement, String, Map<String, String>, String) - Method in class org.wso2.carbon.mediator.cache.digest.REQUESTHASHGenerator: Deprecated.

This is an overloaded method for the digest generation for OMElement and request.
getDigest(String, String, String) - Method in class org.wso2.carbon.mediator.cache.digest.REQUESTHASHGenerator: Deprecated.

This is an overloaded method for the digest generation for HTTP header propery.
getDigestGenerator() - Method in class org.wso2.carbon.mediator.cache.CacheMediator: This method gives the DigestGenerator to evaluate the hash values of incoming messages.
getExpandedName(OMElement) - Method in class org.wso2.carbon.mediator.cache.digest.DOMHASHGenerator: Deprecated.

This is an overloaded method for getting the expanded name as namespaceURI followed by the local name for OMElement.
getExpandedName(OMAttribute) - Method in class org.wso2.carbon.mediator.cache.digest.DOMHASHGenerator: Deprecated.

This is an overloaded method for getting the expanded name as namespaceURI followed by the local name for OMAttribute.
getExpandedName(OMElement) - Method in class org.wso2.carbon.mediator.cache.digest.HttpRequestHashGenerator: This is an overloaded method for getting the expanded name as namespaceURI followed by the local name for OMElement.
getExpandedName(OMAttribute) - Method in class org.wso2.carbon.mediator.cache.digest.HttpRequestHashGenerator: This is an overloaded method for getting the expanded name as namespaceURI followed by the local name for OMAttribute.
getHeaderProperties() - Method in class org.wso2.carbon.mediator.cache.CachableResponse: This method gives the HTTP Header Properties of the response
getHeadersToExcludeInHash() - Method in class org.wso2.carbon.mediator.cache.CacheMediator: This method gives array of headers that would be excluded when hashing.
getHttpMethod() - Method in class org.wso2.carbon.mediator.cache.CachableResponse
getHttpMethod() - Method in class org.wso2.carbon.mediator.cache.CacheMediator
getHTTPMethodsToCache() - Method in class org.wso2.carbon.mediator.cache.CachableResponse: This method gives the HTTP method that needs to be cached.
getHTTPMethodsToCache() - Method in class org.wso2.carbon.mediator.cache.CacheMediator: This method gives the HTTP method that needs to be cached.
getInlineSequence(SynapseConfiguration, int) - Method in class org.wso2.carbon.mediator.cache.CacheMediator
getInMemoryCacheSize() - Method in class org.wso2.carbon.mediator.cache.CacheMediator: This method gives the size of the messages to be cached in memory.
getMaxMessageSize() - Method in class org.wso2.carbon.mediator.cache.CachableResponse: This method gives the maximum size of the messages to be cached in bytes.
getMaxMessageSize() - Method in class org.wso2.carbon.mediator.cache.CacheMediator: This method gives the maximum size of the messages to be cached in bytes.
getMediatorCache() - Method in class org.wso2.carbon.mediator.cache.CacheMediator: Creates default cache to keep mediator cache.
getMediatorClassName() - Method in class org.wso2.carbon.mediator.cache.CacheMediatorSerializer
getMsgCtx() - Method in class org.wso2.carbon.mediator.cache.MediatorCacheInvalidator: This method gives the tenant message context.
getOnCacheHitRef() - Method in class org.wso2.carbon.mediator.cache.CacheMediator: This method gives reference to the onCacheHit sequence to be executed.
getOnCacheHitSequence() - Method in class org.wso2.carbon.mediator.cache.CacheMediator: This method gives SequenceMediator to be executed.
getProtocolType() - Method in class org.wso2.carbon.mediator.cache.CachableResponse
getProtocolType() - Method in class org.wso2.carbon.mediator.cache.CacheMediator
getRequestHash() - Method in class org.wso2.carbon.mediator.cache.CachableResponse: This method gives the hash value of the request payload stored in the cache
getResponseCodePattern() - Method in class org.wso2.carbon.mediator.cache.CachableResponse
getResponseCodes() - Method in class org.wso2.carbon.mediator.cache.CacheMediator
getResponseEnvelope() - Method in class org.wso2.carbon.mediator.cache.CachableResponse
getResponsePayload() - Method in class org.wso2.carbon.mediator.cache.CachableResponse: This method gives the cached response payload for json as a byte array
getStatusCode() - Method in class org.wso2.carbon.mediator.cache.CachableResponse
getStatusReason() - Method in class org.wso2.carbon.mediator.cache.CachableResponse
getStringRepresentation(byte[]) - Method in class org.wso2.carbon.mediator.cache.digest.DOMHASHGenerator: Deprecated.

Gets the String representation of the byte array.
getStringRepresentation(byte[]) - Method in class org.wso2.carbon.mediator.cache.digest.HttpRequestHashGenerator: Gets the String representation of the byte array.
getTagQName() - Method in class org.wso2.carbon.mediator.cache.CacheMediatorFactory
getTenantDomain() - Method in class org.wso2.carbon.mediator.cache.MediatorCacheInvalidator: This method gives the tenant domain.
getTenantId() - Method in class org.wso2.carbon.mediator.cache.MediatorCacheInvalidator: This method gives the tenant ID.
getTimeout() - Method in class org.wso2.carbon.mediator.cache.CachableResponse: This method gives the timeout period in milliseconds
getTimeout() - Method in class org.wso2.carbon.mediator.cache.CacheMediator: This method gives the timeout period in milliseconds.
getValidElements(OMDocument) - Method in class org.wso2.carbon.mediator.cache.digest.DOMHASHGenerator: Deprecated.

Gets the valid element collection of an OMDocument.

H

HASH_GENERATOR_STRING - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants
HEADERS_TO_EXCLUDE_STRING - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants
HTTP_PROTOCOL_TYPE - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants: The HTTP protocol.
HttpRequestHashGenerator - Class in org.wso2.carbon.mediator.cache.digest: The DigestGenerator for the HTTP protocol type.
HttpRequestHashGenerator() - Constructor for class org.wso2.carbon.mediator.cache.digest.HttpRequestHashGenerator

I

IMPLEMENTATION_STRING - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants
init(SynapseEnvironment) - Method in class org.wso2.carbon.mediator.cache.CacheMediator
init(Map<String, Object>) - Method in interface org.wso2.carbon.mediator.cache.digest.DigestGenerator: If more properties are needed to generate the hash other than the MessageContext it can be initialized via this method
init(Map<String, Object>) - Method in class org.wso2.carbon.mediator.cache.digest.DOMHASHGenerator: Deprecated.
init(Map<String, Object>) - Method in class org.wso2.carbon.mediator.cache.digest.HttpRequestHashGenerator
invalidateTheWholeCache() - Method in class org.wso2.carbon.mediator.cache.MediatorCacheInvalidator
invalidateTheWholeCache() - Method in interface org.wso2.carbon.mediator.cache.MediatorCacheInvalidatorMBean: This abstract method should be implemented to invalidate the whole mediator Cache.
isCollector() - Method in class org.wso2.carbon.mediator.cache.CacheMediator: This method gives whether the mediator should be in the incoming path or in the outgoing path as a boolean.
isJson() - Method in class org.wso2.carbon.mediator.cache.CachableResponse

M

MAX_MESSAGE_SIZE_STRING - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants
MAX_SIZE_STRING - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants
MD5_DIGEST_ALGORITHM - Static variable in class org.wso2.carbon.mediator.cache.digest.DOMHASHGenerator: Deprecated.

String representing the MD5 digest algorithm.
MD5_DIGEST_ALGORITHM - Static variable in class org.wso2.carbon.mediator.cache.digest.REQUESTHASHGenerator: Deprecated.

String representing the MD5 digest algorithm.
mediate(MessageContext) - Method in class org.wso2.carbon.mediator.cache.CacheMediator
MediatorCacheInvalidator - Class in org.wso2.carbon.mediator.cache: This class is used for global cache invalidation.
MediatorCacheInvalidator(String, int, MessageContext) - Constructor for class org.wso2.carbon.mediator.cache.MediatorCacheInvalidator: MediatorCacheInvalidator Constructor which creates MBean to expose operations to invalidate the mediator cache.
MediatorCacheInvalidatorMBean - Interface in org.wso2.carbon.mediator.cache: The interface for MBean used to invalidate the cache mediator.
METHODS_STRING - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants

O

ON_CACHE_HIT_STRING - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants
org.wso2.carbon.mediator.cache - package org.wso2.carbon.mediator.cache
org.wso2.carbon.mediator.cache.digest - package org.wso2.carbon.mediator.cache.digest

P

PROTOCOL_STRING - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants

R

REQUEST_HASH - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants: String key to store the the request hash in the message context.
REQUESTHASHGenerator - Class in org.wso2.carbon.mediator.cache.digest: Deprecated.
REQUESTHASHGenerator() - Constructor for class org.wso2.carbon.mediator.cache.digest.REQUESTHASHGenerator: Deprecated.
RESPONSE_CODES_STRING - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants

S

SEQUENCE_STRING - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants
serializeChildren(OMElement, List<Mediator>) - Method in class org.wso2.carbon.mediator.cache.CacheMediatorSerializer: Creates XML representation of the child mediators.
serializeSpecificMediator(Mediator) - Method in class org.wso2.carbon.mediator.cache.CacheMediatorSerializer: Serializes the cache mediator into XML element.
setCollector(boolean) - Method in class org.wso2.carbon.mediator.cache.CacheMediator: This method sets whether the mediator should be in the incoming path or in the outgoing path as a boolean.
setDigestGenerator(DigestGenerator) - Method in class org.wso2.carbon.mediator.cache.CacheMediator: This method sets the DigestGenerator to evaluate the hash values of incoming messages.
setHeaderProperties(Map<String, Object>) - Method in class org.wso2.carbon.mediator.cache.CachableResponse: This method sets the HTTP Header Properties of the response
setHeadersToExcludeInHash(String...) - Method in class org.wso2.carbon.mediator.cache.CacheMediator: This method sets the array of headers that would be excluded when hashing.
setHttpMethod(String) - Method in class org.wso2.carbon.mediator.cache.CachableResponse
setHttpMethod(String) - Method in class org.wso2.carbon.mediator.cache.CacheMediator
setHTTPMethodsToCache(String...) - Method in class org.wso2.carbon.mediator.cache.CachableResponse: This sets the HTTP method that needs to be cached.
setHTTPMethodsToCache(String...) - Method in class org.wso2.carbon.mediator.cache.CacheMediator: This sets the HTTP method that needs to be cached.
setInMemoryCacheSize(int) - Method in class org.wso2.carbon.mediator.cache.CacheMediator: This method sets the size of the messages to be cached in memory.
setJson(boolean) - Method in class org.wso2.carbon.mediator.cache.CachableResponse: Sets whether the response content-type is json or not
setMaxMessageSize(int) - Method in class org.wso2.carbon.mediator.cache.CachableResponse: This method sets the maximum size of the messages to be cached in bytes.
setMaxMessageSize(int) - Method in class org.wso2.carbon.mediator.cache.CacheMediator: This method sets the maximum size of the messages to be cached in bytes.
setMsgCtx(MessageContext) - Method in class org.wso2.carbon.mediator.cache.MediatorCacheInvalidator: This method sets the message context.
setOnCacheHitRef(String) - Method in class org.wso2.carbon.mediator.cache.CacheMediator: This method sets reference to the onCacheHit sequence to be executed.
setOnCacheHitSequence(SequenceMediator) - Method in class org.wso2.carbon.mediator.cache.CacheMediator: This method sets SequenceMediator to be executed.
setProtocolType(String) - Method in class org.wso2.carbon.mediator.cache.CachableResponse: This method sets protocolType of the messages.
setProtocolType(String) - Method in class org.wso2.carbon.mediator.cache.CacheMediator: This method sets protocolType of the messages.
setRequestHash(String) - Method in class org.wso2.carbon.mediator.cache.CachableResponse: This method sets the hash of the request to the cache
setResponseCodePattern(Pattern) - Method in class org.wso2.carbon.mediator.cache.CachableResponse: This method sets the response codes that needs to be cached.
setResponseCodes(String) - Method in class org.wso2.carbon.mediator.cache.CacheMediator: This method sets the response codes that needs to be cached.
setResponseEnvelope(SOAPEnvelope) - Method in class org.wso2.carbon.mediator.cache.CachableResponse
setResponsePayload(byte[]) - Method in class org.wso2.carbon.mediator.cache.CachableResponse: This method sets the response payload to the cache as a byte array
setStatusCode(String) - Method in class org.wso2.carbon.mediator.cache.CachableResponse: Sets the HTTP status code number of the response
setStatusReason(String) - Method in class org.wso2.carbon.mediator.cache.CachableResponse: Sets the HTTP response's Reason-Phrase that is sent by the backend.
setTenantDomain(String) - Method in class org.wso2.carbon.mediator.cache.MediatorCacheInvalidator: This method sets the tenant domain.
setTenantId(int) - Method in class org.wso2.carbon.mediator.cache.MediatorCacheInvalidator: This method sets the tenant ID
setTimeout(long) - Method in class org.wso2.carbon.mediator.cache.CachableResponse: This method sets the timeout period as milliseconds
setTimeout(long) - Method in class org.wso2.carbon.mediator.cache.CacheMediator: This method sets the timeout period as milliseconds.
SHA1_DIGEST_ALGORITHM - Static variable in class org.wso2.carbon.mediator.cache.digest.DOMHASHGenerator: Deprecated.

String representing the SHA1 digest algorithm.
SHA_DIGEST_ALGORITHM - Static variable in class org.wso2.carbon.mediator.cache.digest.DOMHASHGenerator: Deprecated.

String representing the SHA digest algorithm.

T

TIMEOUT_STRING - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants: Following names represent the local names used in QNames in MediatorFactory, Serializer and the UI CacheMediator.
TYPE_STRING - Static variable in class org.wso2.carbon.mediator.cache.CachingConstants

A C D E G H I M O P R S T