org.openanzo.atom.cache
Class AtomCache

java.lang.Object
  org.openanzo.atom.cache.AtomCache

All Implemented Interfaces:

AtomConstants

Direct Known Subclasses:

LRUAtomCache, MemcachedAtomCache

public abstract class AtomCache
extends java.lang.Object
implements AtomConstants

Author:

Ben Szekely (bhszekel@us.ibm.com)

Nested Class Summary

static class	AtomCache.NamedGraphRoleEntry
static class	AtomCache.OutputCacheEntry
static class	AtomCache.UserCacheEntry

Field Summary

Fields inherited from interface org.openanzo.atom.AtomConstants

ANCHOR, ATOM_SERVER_NAME, ATOM_SERVER_VERSION, BINARY_CONTENT_SRC, BINARY_CONTENT_TYPE, BINARY_CONTENT_VERSION, CLIENT_DOJO, COLLECTION_PAGE_SIZE, CONTENT_ATOM_XML, CONTENT_ATOM_XML_UTF8, CONTENT_ATOMSERV_XML, CONTENT_ATOMSERV_XML_UTF8, CONTENT_HTML, CONTENT_JSON, CONTENT_MULTIPART_FORM_DATA, CONTENT_RDF_XML, CONTENT_TEXT, CONTENT_XHTML, CONTENT_XHTML_SHORT, CONTENT_XML, DELIM, EDIT, ENTRY, HEADER_ACCEPT, HEADER_ALLOW, HEADER_CONTENT_LOCATION, HEADER_CONTENT_TYPE, HEADER_ETAG, HEADER_LOCATION, HEADER_TITLE, HISTORY, HTTP_BAD_REQUEST, HTTP_CONFLICT, HTTP_CREATED, HTTP_FORBIDDEN, HTTP_GONE, HTTP_INTERNAL_SERVER_ERROR, HTTP_METHOD_NOT_ALLOWED, HTTP_NOT_AUTHORIZED, HTTP_NOT_FOUND, HTTP_NOT_MODIFIED, HTTP_OK, HTTP_UNSUPPORTED_MEDIA, INVALID_ATOM_ENTRY, INVALID_COLLECTION_URI, LINK_REL_ALTERNATE, LINK_REL_ANCHOR, LINK_REL_COLLECTION, LINK_REL_CONTENT_GRAPH, LINK_REL_EDIT, LINK_REL_EDIT_MEDIA, LINK_REL_FIRST, LINK_REL_HISTORY, LINK_REL_INTROSPECTION, LINK_REL_LAST, LINK_REL_NEXT, LINK_REL_PREVIOUS, LINK_REL_RELATED, LINK_REL_SELF, MEDIA, NS_QUESO, NS_XHTML, PREFIX_QUESO, QUESO_NS, REQUEST_PARAMETER_ACCEPT, REQUEST_PARAMETER_CLIENT, REQUEST_PARAMETER_COLLECTION_URI, SPECIAL_RESOURCE_THISENTRY, SPECIAL_RESOURCE_TIMESTAMP, UNKNOWN_SERVER_ERROR, X_OVERRIDE_HEADER, X_STATUS_HEADER, XSD_ANYURI, XSD_INT, XSD_STRING

Method Summary

boolean	addUserToRole(java.lang.String userId, java.lang.String role)
java.lang.String	authenticateUser(java.lang.String userId, java.lang.String password)
void	clear()
void	clearUser(java.lang.String userUri)
java.lang.String	generateContentKey(java.lang.String id, java.lang.Long revision, java.lang.String contentType)
abstract CacheTableFactory	getCacheTableFactory()
AtomCache.OutputCacheEntry	getContent(java.lang.String key, java.lang.String userId)
static AtomCache	getInstance(java.util.Properties properties)
java.lang.Long	getNamedGraphRevision(java.lang.String id, java.lang.String userId)
java.lang.Long	getNamedGraphRevision(java.lang.String id, java.lang.String userId, boolean fallback)
java.lang.String	getUserId(java.lang.String userUri)
void	init(java.util.Properties properties)
boolean	isCacheEnabled()
void	loadRoles(java.lang.String nguri)
void	removeNamedGraphRevision(java.lang.String id)
boolean	removeUserFromRole(java.lang.String userId, java.lang.String role)
void	setAtomModel(AtomModel atomModel)
void	setCacheEnabled(boolean cacheEnabled)
void	setContent(java.lang.String key, AtomCache.OutputCacheEntry content)
static void	setInstance(AtomCache instance)
void	setNamedGraphRevision(java.lang.String id, java.lang.Long revision)
void	setPassword(java.lang.String userId, java.lang.String password, java.lang.String uri)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setInstance

public static void setInstance(AtomCache instance)

getInstance

public static AtomCache getInstance(java.util.Properties properties)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getCacheTableFactory

public abstract CacheTableFactory getCacheTableFactory()
                                                throws CacheException

Throws:

CacheException

setAtomModel

public void setAtomModel(AtomModel atomModel)

init

public void init(java.util.Properties properties)
          throws AtomServerException

Throws:

AtomServerException

clear

public void clear()
           throws java.lang.Exception

Throws:

java.lang.Exception

getNamedGraphRevision

public java.lang.Long getNamedGraphRevision(java.lang.String id,
                                            java.lang.String userId)
                                     throws AnzoException,
                                            CacheException

Throws:

AnzoException

CacheException

getNamedGraphRevision

public java.lang.Long getNamedGraphRevision(java.lang.String id,
                                            java.lang.String userId,
                                            boolean fallback)
                                     throws AnzoException,
                                            CacheException

Throws:

AnzoException

CacheException

setNamedGraphRevision

public void setNamedGraphRevision(java.lang.String id,
                                  java.lang.Long revision)
                           throws java.lang.Exception

Throws:

java.lang.Exception

removeNamedGraphRevision

public void removeNamedGraphRevision(java.lang.String id)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getContent

public AtomCache.OutputCacheEntry getContent(java.lang.String key,
                                             java.lang.String userId)

setContent

public void setContent(java.lang.String key,
                       AtomCache.OutputCacheEntry content)
                throws CacheException

Throws:

CacheException

loadRoles

public void loadRoles(java.lang.String nguri)
               throws CacheException

Throws:

CacheException

generateContentKey

public java.lang.String generateContentKey(java.lang.String id,
                                           java.lang.Long revision,
                                           java.lang.String contentType)

setPassword

public void setPassword(java.lang.String userId,
                        java.lang.String password,
                        java.lang.String uri)
                 throws AtomServerException

Throws:

AtomServerException

authenticateUser

public java.lang.String authenticateUser(java.lang.String userId,
                                         java.lang.String password)
                                  throws AtomServerException

Throws:

AtomServerException

getUserId

public java.lang.String getUserId(java.lang.String userUri)
                           throws AtomServerException

Throws:

AtomServerException

clearUser

public void clearUser(java.lang.String userUri)

addUserToRole

public boolean addUserToRole(java.lang.String userId,
                             java.lang.String role)

removeUserFromRole

public boolean removeUserFromRole(java.lang.String userId,
                                  java.lang.String role)

isCacheEnabled

public boolean isCacheEnabled()

setCacheEnabled

public void setCacheEnabled(boolean cacheEnabled)