站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JBOSS Portal 2.2 API 英文版文档

HibernateCacheLoader - JBOSS Portal 2.2 API 英文版文档

Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jboss.portal.core.security.store
Class HibernateCacheLoader

java.lang.Object
  extended byorg.jboss.mx.util.JBossNotificationBroadcasterSupport
      extended byorg.jboss.system.ServiceMBeanSupport
          extended byorg.jboss.portal.common.system.AbstractJBossService
              extended byorg.jboss.portal.core.security.store.HibernateCacheLoader
All Implemented Interfaces:
javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, javax.management.NotificationEmitter, org.jboss.system.Service, org.jboss.system.ServiceMBean
public class HibernateCacheLoader
extends AbstractJBossService

Field Summary
 
Fields inherited from class org.jboss.system.ServiceMBeanSupport
log, server, SERVICE_CONTROLLER_SIG, serviceName
 
Fields inherited from interface org.jboss.system.ServiceMBean
CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED
 
Constructor Summary
HibernateCacheLoader()
           
 
Method Summary
 void commit(java.lang.Object tx)
           
 void createService()
           
 void destroyService()
           
 boolean exists(Fqn fqn)
          Checks that there is a row for the fqn in the database.
 java.util.Map get(Fqn fqn)
          Returns a map representing a node.
 java.lang.Object get(Fqn fqn, java.lang.Object key)
          Loads an attribute from the database.
 java.util.Set getChildrenNames(Fqn parentName)
          Fetches child node names (not path's).
 byte[] loadEntireState()
          Loads the entire state from the filesystem and returns it as a byte buffer.
 void prepare(java.lang.Object tx, java.util.List modifications, boolean one_phase)
          First phase in transaction commit process.
 void put(Fqn fqn, java.util.Map attributes)
          Adds attributes from the passed in map to the existing node.
 java.lang.Object put(Fqn fqn, java.lang.Object key, java.lang.Object value)
          Adds/overrides a value in a node for a key.
 void put(java.util.List modifications)
           
 void remove(Fqn name)
          Removes a node and all its children.
 java.lang.Object remove(Fqn fqn, java.lang.Object key)
          Removes attribute's value for a key.
 void removeData(Fqn fqn)
          Nullifies the node.
 void rollback(java.lang.Object tx)
          Rolls back a transaction.
 void setCache(TreeCache cache)
           
 void setConfig(java.util.Properties config)
           
 void startService()
           
 void stopService()
           
 void storeEntireState(byte[] state)
          Store the state given as a byte buffer to the database.
 
Methods inherited from class org.jboss.portal.common.system.AbstractJBossService
create, destroy, getState, getStateString, start, stop
 
Methods inherited from class org.jboss.system.ServiceMBeanSupport
getDeploymentInfo, getLog, getName, getNextNotificationSequenceNumber, getObjectName, getServer, getServiceName, jbossInternalCreate, jbossInternalDescription, jbossInternalDestroy, jbossInternalLifecycle, jbossInternalStart, jbossInternalStop, postDeregister, postRegister, preDeregister, preRegister
 
Methods inherited from class org.jboss.mx.util.JBossNotificationBroadcasterSupport
addNotificationListener, getNotificationInfo, handleNotification, nextNotificationSequenceNumber, removeNotificationListener, removeNotificationListener, sendNotification
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HibernateCacheLoader

public HibernateCacheLoader()
Method Detail

setConfig

public void setConfig(java.util.Properties config)

setCache

public void setCache(TreeCache cache)

createService

public void createService()
                   throws java.lang.Exception
Throws:
java.lang.Exception

startService

public void startService()
                  throws java.lang.Exception
Throws:
java.lang.Exception

stopService

public void stopService()

destroyService

public void destroyService()

getChildrenNames

public java.util.Set getChildrenNames(Fqn parentName)
                               throws java.lang.Exception
Fetches child node names (not path's).

Parameters:
parentName - parent parentName
Returns:
a set of child node names or null if there are not children found for the parentName
Throws:
java.lang.Exception

get

public java.lang.Object get(Fqn fqn,
                            java.lang.Object key)
                     throws java.lang.Exception
Loads an attribute from the database.

Parameters:
fqn - node's fqn
key - attribute's key
Returns:
attribute's value. Null is returned if
  • there is no value for the attribute key in the node
  • there is a row in the table for the fqn but the node column contains null
  • there is no row in table for the fqn (should this result in an exception?)
Throws:
java.lang.Exception

get

public java.util.Map get(Fqn fqn)
                  throws java.lang.Exception
Returns a map representing a node.

Parameters:
fqn - node's fqn
Returns:
node
Throws:
java.lang.Exception

exists

public boolean exists(Fqn fqn)
               throws java.lang.Exception
Checks that there is a row for the fqn in the database.

Parameters:
fqn - node's fqn
Returns:
true if there is a row in the database for the given fqn even if the node column is null.
Throws:
java.lang.Exception

put

public java.lang.Object put(Fqn fqn,
                            java.lang.Object key,
                            java.lang.Object value)
                     throws java.lang.Exception
Adds/overrides a value in a node for a key. If the node does not exist yet, the node will be created. If parent nodes do not exist for the node, empty parent nodes will be created.

Parameters:
fqn - node's fqn
key - attribute's key
value - attribute's value
Returns:
old value associated with the attribute's key or null if there was no value previously associated with the attribute's key
Throws:
java.lang.Exception

put

public void put(Fqn fqn,
                java.util.Map attributes)
         throws java.lang.Exception
Adds attributes from the passed in map to the existing node. If there is no node for the fqn, a new node will be created.

Parameters:
fqn - node's fqn
attributes - attributes
Throws:
java.lang.Exception

put

public void put(java.util.List modifications)
         throws java.lang.Exception
Throws:
java.lang.Exception

remove

public java.lang.Object remove(Fqn fqn,
                               java.lang.Object key)
                        throws java.lang.Exception
Removes attribute's value for a key. If after removal the node contains no attributes, the node is nullified.

Parameters:
fqn - node's name
key - attribute's key
Returns:
removed value or null if there was no value for the passed in key
Throws:
java.lang.Exception

remove

public void remove(Fqn name)
            throws java.lang.Exception
Removes a node and all its children. Uses the same connection for all the db work.

Parameters:
name - node's fqn
Throws:
java.lang.Exception

removeData

public void removeData(Fqn fqn)
                throws java.lang.Exception
Nullifies the node.

Parameters:
fqn - node's fqn
Throws:
java.lang.Exception

prepare

public void prepare(java.lang.Object tx,
                    java.util.List modifications,
                    boolean one_phase)
             throws java.lang.Exception
First phase in transaction commit process. The changes are committed if only one phase if requested. All the modifications are committed using the same connection.

Parameters:
tx - something representing transaction
modifications - a list of modifications
one_phase - indicates whether it's one or two phase commit transaction
Throws:
java.lang.Exception

commit

public void commit(java.lang.Object tx)
            throws java.lang.Exception
Throws:
java.lang.Exception

rollback

public void rollback(java.lang.Object tx)
Rolls back a transaction.

Parameters:
tx - the tx to rollback

loadEntireState

public byte[] loadEntireState()
                       throws java.lang.Exception
Loads the entire state from the filesystem and returns it as a byte buffer. The format of the byte buffer must be a list of NodeData elements

Returns:
Throws:
java.lang.Exception

storeEntireState

public void storeEntireState(byte[] state)
                      throws java.lang.Exception
Store the state given as a byte buffer to the database. The byte buffer contains a list of zero or more NodeData elements

Parameters:
state -
Throws:
java.lang.Exception
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD