org.alfresco.mbeans

Class VirtServerRegistry

java.lang.Object

org.alfresco.mbeans.VirtServerRegistry

All Implemented Interfaces:

VirtServerRegistryMBean, org.springframework.context.ApplicationContextAware

public class VirtServerRegistry
extends Object
implements VirtServerRegistryMBean

Constructor Summary

Constructors

Constructor and Description
VirtServerRegistry()

Method Summary

Methods

Modifier and Type	Method and Description
void	closeJmxRmiConnection()
String	getAccessFile() Gets access "role" file used by virt server
String	getPasswordFile() Gets password file used to access virt server
String	getVirtServerFQDN()
Integer	getVirtServerHttpPort()
String	getVirtServerJmxUrl()
void	initialize()
protected boolean	jmxRmiWebappNotification(String action, int version, String pathToWebapp, boolean isRecursive)
boolean	pingVirtServer() Fast check of the accessibility of the virtualization server.
void	registerVirtServerInfo(String virtServerJmxUrl, String virtServerFQDN, Integer virtServerHttpPort) Accepts the registration of a remote virtualization server's JMXServiceURL, FQDN, and HTTP port.
boolean	removeAllWebapps(int version, String path, boolean isRecursive) Notifies remote listener that a AVM-based webapp has been removed.
boolean	removeWebapp(int version, String pathToWebapp, boolean isRecursive) Notifies remote listener that a AVM-based webapp has been removed.
void	setAccessFile(String path) Sets access "role" file used by virt server
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setPasswordFile(String path) Sets password file used to access virt server
boolean	updateAllWebapps(int version, String path, boolean isRecursive) Notifies remote listener that a AVM-based webapp has been updated; an "update" is any change to (or creation of) contents within WEB-INF/classes WEB-INF/lib, WEB-INF/web.xml of a webapp.
boolean	updateWebapp(int version, String pathToWebapp, boolean isRecursive) Notifies remote listener that a AVM-based webapp has been updated; an "update" is any change to (or creation of) contents within WEB-INF/classes WEB-INF/lib, WEB-INF/web.xml of a webapp.
boolean	verifyJmxRmiConnection()

Methods inherited from class java.lang.Object

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

Constructor Detail

VirtServerRegistry

public VirtServerRegistry()

Method Detail

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

initialize

public void initialize()

Specified by:

initialize in interface VirtServerRegistryMBean

setPasswordFile

public void setPasswordFile(String path)

Description copied from interface: VirtServerRegistryMBean

Sets password file used to access virt server

Specified by:

setPasswordFile in interface VirtServerRegistryMBean

getPasswordFile

public String getPasswordFile()

Description copied from interface: VirtServerRegistryMBean

Gets password file used to access virt server

Specified by:

getPasswordFile in interface VirtServerRegistryMBean

setAccessFile

public void setAccessFile(String path)

Description copied from interface: VirtServerRegistryMBean

Sets access "role" file used by virt server

Specified by:

setAccessFile in interface VirtServerRegistryMBean

getAccessFile

public String getAccessFile()

Description copied from interface: VirtServerRegistryMBean

Gets access "role" file used by virt server

Specified by:

getAccessFile in interface VirtServerRegistryMBean

getVirtServerHttpPort

public Integer getVirtServerHttpPort()

Specified by:

getVirtServerHttpPort in interface VirtServerRegistryMBean

getVirtServerFQDN

public String getVirtServerFQDN()

Specified by:

getVirtServerFQDN in interface VirtServerRegistryMBean

registerVirtServerInfo

public void registerVirtServerInfo(String virtServerJmxUrl,
                          String virtServerFQDN,
                          Integer virtServerHttpPort)

Accepts the registration of a remote virtualization server's JMXServiceURL, FQDN, and HTTP port. The JMXServiceURL is used to broadcast updates regarding the WEB-INF directory, and start/stop events. The FQDN and HTTP port are used to create URLs for viewing virtualized content. Note: a JMXServiceURL tends to look something like this: service:jmx:rmi:///jndi/rmi://some-remote-hostname:50501/alfresco/jmxrmi

Specified by:

registerVirtServerInfo in interface VirtServerRegistryMBean

getVirtServerJmxUrl

public String getVirtServerJmxUrl()

Specified by:

getVirtServerJmxUrl in interface VirtServerRegistryMBean

updateWebapp

public boolean updateWebapp(int version,
                   String pathToWebapp,
                   boolean isRecursive)

Notifies remote listener that a AVM-based webapp has been updated; an "update" is any change to (or creation of) contents within WEB-INF/classes WEB-INF/lib, WEB-INF/web.xml of a webapp.

Specified by:

updateWebapp in interface VirtServerRegistryMBean

Parameters:

version - The version of the webapp being updated. Typically, this is set to -1, which corresponds to the very latest version ("HEAD"). If versinon != -1, you might want to consider setting the 'isRecursive' parameter to false.

pathToWebapp - The full AVM path to the webapp being updated. For example: storeName:/www/avm_webapps/your_webapp

isRecursive - When true, update all webapps that depend on this one. For example, an author's webapps share jar/class files with the master version in staging; thus, the author's webapp "depends" on the webapp in staging. Similarly, webapps in an author's preview area depend on the ones in the "main" layer of the author's sandbox. You might wish to set this parameter to 'false' if the goal is to bring a non-HEAD version of a staging area online, without forcing the virtualization server to load all the author sandboxes for this archived version as well.

updateAllWebapps

public boolean updateAllWebapps(int version,
                       String path,
                       boolean isRecursive)

Notifies remote listener that a AVM-based webapp has been updated; an "update" is any change to (or creation of) contents within WEB-INF/classes WEB-INF/lib, WEB-INF/web.xml of a webapp.

Specified by:

updateAllWebapps in interface VirtServerRegistryMBean

Parameters:

version - The version of the webapp being updated. Typically, this is set to -1, which corresponds to the very latest version ("HEAD"). If versinon != -1, you might want to consider setting the 'isRecursive' parameter to false.

path - The full AVM path to the webapp(s) being updated. For example: storeName:/www/avm_webapps/your_webapp or: storeName:/www/avm_webapps

isRecursive - When true, update all webapps that depend on this one. For example, an author's webapps share jar/class files with the master version in staging; thus, the author's webapp "depends" on the webapp in staging. Similarly, webapps in an author's preview area depend on the ones in the "main" layer of the author's sandbox. You might wish to set this parameter to 'false' if the goal is to bring a non-HEAD version of a staging area online, without forcing the virtualization server to load all the author sandboxes for this archived version as well.

removeWebapp

public boolean removeWebapp(int version,
                   String pathToWebapp,
                   boolean isRecursive)

Notifies remote listener that a AVM-based webapp has been removed.

Specified by:

removeWebapp in interface VirtServerRegistryMBean

Parameters:

version - The version of the webapp being removed. Typically, this is set to -1, which corresponds to the very latest version ("HEAD"). If versinon != -1, you might want to consider setting the 'isRecursive' parameter to false.

pathToWebapp - The full AVM path to the webapp being removed. For example: storeName:/www/avm_webapps/your_webapp

isRecursive - When true, remove all webapps that depend on this one. For example, an author's webapps share jar/class files with the master version in staging; thus, the author's webapp "depends" on the webapp in staging. Similarly, webapps in an author's preview area depend on the ones in the "main" layer of the author's sandbox. You might wish to set this parameter to 'false' if the goal is to bring a non-HEAD version of a staging area online, without forcing the virtualization server to load all the author sandboxes for this archived version as well.

removeAllWebapps

public boolean removeAllWebapps(int version,
                       String path,
                       boolean isRecursive)

Notifies remote listener that a AVM-based webapp has been removed.

Specified by:

removeAllWebapps in interface VirtServerRegistryMBean

Parameters:

version - The version of the webapp being removed. Typically, this is set to -1, which corresponds to the very latest version ("HEAD"). If versinon != -1, you might want to consider setting the 'isRecursive' parameter to false.

path - The full AVM path to the webapp(s) being removed. For example: storeName:/www/avm_webapps/your_webapp or: storeName:/www/avm_webapps

isRecursive - When true, remove all webapps that depend on this one. For example, an author's webapps share jar/class files with the master version in staging; thus, the author's webapp "depends" on the webapp in staging. Similarly, webapps in an author's preview area depend on the ones in the "main" layer of the author's sandbox. You might wish to set this parameter to 'false' if the goal is to bring a non-HEAD version of a staging area online, without forcing the virtualization server to load all the author sandboxes for this archived version as well.

verifyJmxRmiConnection

public boolean verifyJmxRmiConnection()

pingVirtServer

public boolean pingVirtServer()

Fast check of the accessibility of the virtualization server.

Returns:

Returns true if server is accessible.

See Also:

org.alfresco.linkvalidation.LinkValidationServiceImpl

jmxRmiWebappNotification

protected boolean jmxRmiWebappNotification(String action,
                               int version,
                               String pathToWebapp,
                               boolean isRecursive)

closeJmxRmiConnection

public void closeJmxRmiConnection()