org.mmbase.module.builders
Class NetFileSrv

java.lang.Object
  org.mmbase.util.functions.FunctionProvider
      org.mmbase.module.core.MMTable
          org.mmbase.module.core.MMObjectBuilder
              org.mmbase.module.builders.NetFileSrv

All Implemented Interfaces:

EventListener, NodeEventListener, RelationEventListener

public class NetFileSrv
extends MMObjectBuilder

The NetFileServ builder contains information on services available to NetFile objects. It contains a list of possible service/subservice tasks. These tasks are then attached to entries in the VWMs builder, so it is possible to search for a VWM to handle a service/subservice request. The fields of NetFileServ are:

• service : the main 'service' to be performed. Together with subservice, this determines the VWM that handles the transfer, i.e. 'pages/main' is handled by the PageMaster VWM.
• subservice : the subservice to perform. i.e. in PageMaster, 'main' determines mirror sites and schedules tasks for mirroring (by creating net netfile entries), while 'mirror' performs the actual transfer to a mirror
  Often one VWM handles multiple subservices, but this is not a given.
• options : Currently unused (?)

Version:

$Id: NetFileSrv.java 35335 2009-05-21 08:14:41Z michiel $

Author:

Daniel Ockeloen

Field Summary

(package private) Hashtable<String,Object>

service2bot Cache of VWMS as they are related to a service.

Fields inherited from class org.mmbase.module.core.MMObjectBuilder

AGE_PARAMETERS, broadCastChanges, DEFAULT_ALINEA, DEFAULT_EOL, description, descriptions, EVENT_TYPE_LOCAL, EVENT_TYPE_REMOTE, FIELD_NUMBER, FIELD_OBJECT_TYPE, FIELD_OWNER, fields, genericBlobCache, getFunctions, GUI_INDICATOR, GUI_PARAMETERS, guiFunction, infoFunction, internalVersion, nodeCache, oType, pluralNames, searchAge, singularNames, SYSTEM_OWNER, TEMPNODE_DEFAULT_SIZE, TMP_FIELD_EXISTS, TMP_FIELD_NUMBER, virtual, WRAP_PARAMETERS, wrapFunction

Fields inherited from class org.mmbase.module.core.MMTable

maxNodesFromQuery, mmb, storageConnector, tableName

Fields inherited from class org.mmbase.util.functions.FunctionProvider

functions

Constructor Summary

NetFileSrv()

Method Summary

boolean	fileChange(String number, String ctype) Handles a change of a netfiles node.
boolean	fileChange(String service, String subservice, String filename) Handles a service request on a file.
Object	getAttachedBot(String service, String subservice) Retrieve a vwm (a 'bot') for the service/subservice combination.
String	getGUIIndicator(MMObjectNode node) What should a GUI display for this node.

Methods inherited from class org.mmbase.module.core.MMObjectBuilder

addEventListener, addField, addLocalObserver, addRemoteObserver, broadcastChanges, checkAddTmpField, clearBlobCache, commit, create, createAlias, createAlias, delete, equals, equals, executeFunction, executeFunction, fieldLocalChanged, getAncestors, getBlobCache, getClassName, getConfigFile, getConfigResource, getDataTypeCollector, getDBState, getDBType, getDefaultTeaser, getDefaultUrl, getDescendants, getDescription, getDescription, getDescriptions, getEmptyNode, getField, getFieldNames, getFields, getFields, getFunction, getFunctionParameters, getFunctions, getGUIIndicator, getGUIIndicator, getHTML, getInitParameter, getInitParameters, getInitParameters, getInternalVersion, getList, getLocaleGUIIndicator, getLocaleGUIIndicator, getMachineName, getMaintainer, getNewNode, getNewTmpNode, getNextField, getNextField, getNode, getNode, getNode, getNodeFromCache, getNodeGUIIndicator, getNumber, getObjectType, getObjectValue, getParentBuilder, getPluralName, getPluralName, getPluralNames, getRelations_main, getSearchAge, getShort, getShortedByte, getShortedInputStream, getShortedText, getSingularName, getSingularName, getSingularNames, getSmartPath, getTmpNode, getURLEncode, getValue, getVersion, getWAP, getXMLPath, hasField, hashCode, hashCode, hostname_function, init, insert, insert, isExtensionOf, isNodeCached, isNull, isVirtual, loadInitParameters, newFunctionInstance, nodeLocalChanged, nodeRemoteChanged, notify, notify, preCommit, process, removeEventListener, removeField, removeLocalObserver, removeNode, removeRelations, removeRemoteObserver, removeSyncNodes, replace, safeCache, sendFieldChangeSignal, setDefaults, setDescription, setDescriptions, setFields, setInitParameter, setMaintainer, setPluralNames, setSearchAge, setSingularNames, setUniqueValue, setUniqueValue, setValue, setValue, setVersion, setXMLPath, shutdown, testValidData, toString, toString, update, updateFields, wrap

Methods inherited from class org.mmbase.module.core.MMTable

count, count, created, getFullTableName, getMMBase, getNode, getNodes, getNodes, getNodes, getNodeType, getStorageConnector, getTableName, search, searchVector, setMMBase, setTableName, size

Methods inherited from class org.mmbase.util.functions.FunctionProvider

addFunction, createParameters, getFunction, getFunctions, getFunctionValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

service2bot

Hashtable<String,Object> service2bot

Cache of VWMS as they are related to a service.

Constructor Detail

NetFileSrv

public NetFileSrv()

Method Detail

getGUIIndicator

public String getGUIIndicator(MMObjectNode node)

What should a GUI display for this node. Returns a description of the service and subservice.

Overrides:

getGUIIndicator in class MMObjectBuilder

Parameters:

node - The node to display

Returns:

the display of the node as a String

fileChange

public boolean fileChange(String number,
                          String ctype)

Handles a change of a netfiles node. Depending on the service/subservice of that node, a VWM (such as PageMaster) is invoked. This method is called from the Netfiles builder whenever a local or remote node change occurs.

Parameters:

number - Number of the node in the netfiles buidler than contain service request information.

ctype - the type of change on that node ("c" : node was changed)

Returns:

true

fileChange

public boolean fileChange(String service,
                          String subservice,
                          String filename)

Handles a service request on a file. Depending on the service/subservice, a VWM (such as PageMaster) is invoked. This method is called from the scancache module to handle page caching. The VWM invoked is responsible for creating NetFile entries (if needed).

Parameters:

service - the service to be performed

subservice - the subservice to be performed

filename - the filename to service

Returns:

true if maintenance was performed, false otherwise

getAttachedBot

public Object getAttachedBot(String service,
                             String subservice)

Retrieve a vwm (a 'bot') for the service/subservice combination. This is achieved by following the relations of NetFileServ entries to entries in the VWMs builder. Note that while, theoretically, more vwms could be related, only one (the first) is returned.

Parameters:

service - the service to search for

subservice - the subservice to search for

Returns:

an object that implements VWMInterface if successful, a dummy object otherwise. This system is a bit odd as getAttachedBot would ideally have VwmServiceInterface as a return type. Possibly change this later, though this also means changing the caching system.