org.alfresco.service.descriptor
Interface DescriptorService

All Known Implementing Classes:
DescriptorServiceImpl

public interface DescriptorService

Service for retrieving meta-data about Alfresco stack.


Method Summary
 Descriptor getCurrentRepositoryDescriptor()
          Get current descriptor for the repository.
 Descriptor getInstalledRepositoryDescriptor()
          Get descriptor for the repository as it was when first installed.
 LicenseDescriptor getLicenseDescriptor()
          Gets the License Descriptor
 Descriptor getServerDescriptor()
          Get descriptor for the alfresco software installed on the server.
 java.lang.String loadLicense()
          Attempts to load the license.
 

Method Detail

getServerDescriptor

@NotAuditable
Descriptor getServerDescriptor()
Get descriptor for the alfresco software installed on the server.

The information contained by this descriptor is read from a property file. The following properties are available in the descriptor

The following properties are not applicable to the server descriptor.

Returns:
server descriptor

getCurrentRepositoryDescriptor

@NotAuditable
Descriptor getCurrentRepositoryDescriptor()
Get current descriptor for the repository.

The information in this descriptor is read from a node in the system store. After the patch process runs successfully, the version Major/Minor/Revision should be equal to the server descriptor.

The "repository id" that uniquely identifies each alfresco repository is available in the "id" property.

The following properties are available in the descriptor

The following properties may be present

Returns:
repository descriptor

getInstalledRepositoryDescriptor

@NotAuditable
Descriptor getInstalledRepositoryDescriptor()
Get descriptor for the repository as it was when first installed.

The information in this descriptor is read from a node in the system store.

Returns:
repository descriptor

getLicenseDescriptor

@NotAuditable
LicenseDescriptor getLicenseDescriptor()
Gets the License Descriptor

Returns:
the license descriptor

loadLicense

java.lang.String loadLicense()
Attempts to load the license.

Returns:
Returns a message telling the user what happened


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.