|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.metamatrix.platform.admin.apiimpl.ExtensionSourceAdminAPIImpl
@RolesAllowed(value="Admin.ReadOnlyAdmin") public class ExtensionSourceAdminAPIImpl
Field Summary |
---|
Fields inherited from interface com.metamatrix.platform.admin.api.ExtensionSourceAdminAPI |
---|
SOURCE_DESCRIPTION_LENGTH_LIMIT, SOURCE_NAME_LENGTH_LIMIT |
Method Summary | |
---|---|
ExtensionModuleDescriptor |
addSource(java.lang.String type,
java.lang.String sourceName,
byte[] source,
java.lang.String description,
boolean enabled)
Adds an extension source to the end of the list of sources |
static ExtensionSourceAdminAPI |
getInstance()
|
ExtensionModuleDescriptor |
getSourceDescriptor(java.lang.String sourceName)
Returns the ExtensionSourceDescriptor object for the extension source indicated by sourceName |
java.util.List |
getSourceDescriptors()
Returns List of ExtensionSourceDescriptor objects, in order of their search ordering |
java.util.List |
getSourceNames()
Returns List (of Strings) of all extension source names, in order of their search ordering |
java.util.Collection |
getSourceTypes()
Returns List (of Strings) of all extension source types currently supported. |
boolean |
isSourceExists(java.lang.String sourceName)
Checks if the extension module exists. |
void |
removeSource(java.lang.String sourceName)
Deletes a source from the list of sources |
java.util.List |
setEnabled(java.util.Collection sourceNames,
boolean enabled)
Sets the "enabled" (for searching) property of all of the indicated extension sources. |
java.util.List |
setSearchOrder(java.util.List sourceNames)
Sets the positions in the search order of all sources (all sources must be included or an ExtensionSourceOrderingException will be thrown) The sourceNames List parameter should indicate the new desired order. |
ExtensionModuleDescriptor |
setSource(java.lang.String sourceName,
byte[] source)
Updates the indicated extension source |
ExtensionModuleDescriptor |
setSourceDescription(java.lang.String sourceName,
java.lang.String description)
Updates the indicated extension source's description |
ExtensionModuleDescriptor |
setSourceName(java.lang.String sourceName,
java.lang.String newName)
Updates the indicated extension source's source name |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static ExtensionSourceAdminAPI getInstance()
@RolesAllowed(value="Admin.SystemAdmin") public ExtensionModuleDescriptor addSource(java.lang.String type, java.lang.String sourceName, byte[] source, java.lang.String description, boolean enabled) throws InvalidSessionException, AuthorizationException, DuplicateExtensionModuleException, InvalidExtensionModuleTypeException, MetaMatrixComponentException
addSource
in interface ExtensionSourceAdminAPI
type
- one of the known types of extension filesourceName
- name (e.g. filename) of extension sourcesource
- actual contents of sourcedescription
- (optional) description of the extension sourceenabled
- indicates whether each extension source is enabled for
being searched or not (for convenience, a source can be disabled
without being removed)
InvalidSessionException
- if there is not a valid administrative session
AuthorizationException
- if the administrator does not have privileges to use this method
DuplicateExtensionSourceException
- if an extension source
with the same sourceName already exists
InvalidExtensionTypeException
- if the indicated type is not one
of the currently-supported extension source types
MetaMatrixComponentException
- indicating a non-business-related
exception (such as a communication exception)
DuplicateExtensionModuleException
InvalidExtensionModuleTypeException
@RolesAllowed(value="Admin.SystemAdmin") public void removeSource(java.lang.String sourceName) throws InvalidSessionException, AuthorizationException, ExtensionModuleNotFoundException, MetaMatrixComponentException
removeSource
in interface ExtensionSourceAdminAPI
sourceName
- name (e.g. filename) of extension source
InvalidSessionException
- if there is not a valid administrative session
AuthorizationException
- if the administrator does not have privileges to use this method
ExtensionSourceNotFoundException
- if no extension source with
name sourceName can be found
MetaMatrixComponentException
- indicating a non-business-related
exception (such as a communication exception)
ExtensionModuleNotFoundException
public java.util.Collection getSourceTypes() throws InvalidSessionException, AuthorizationException, MetaMatrixComponentException
getSourceTypes
in interface ExtensionSourceAdminAPI
InvalidSessionException
- if there is not a valid administrative session
AuthorizationException
- if the administrator does not have privileges to use this method
MetaMatrixComponentException
- indicating a non-business-related
exception (such as a communication exception)public java.util.List getSourceNames() throws InvalidSessionException, AuthorizationException, MetaMatrixComponentException
getSourceNames
in interface ExtensionSourceAdminAPI
InvalidSessionException
- if there is not a valid administrative session
AuthorizationException
- if the administrator does not have privileges to use this method
MetaMatrixComponentException
- indicating a non-business-related
exception (such as a communication exception)public java.util.List getSourceDescriptors() throws InvalidSessionException, AuthorizationException, MetaMatrixComponentException
getSourceDescriptors
in interface ExtensionSourceAdminAPI
InvalidSessionException
- if there is not a valid administrative session
AuthorizationException
- if the administrator does not have privileges to use this method
MetaMatrixComponentException
- indicating a non-business-related
exception (such as a communication exception)public ExtensionModuleDescriptor getSourceDescriptor(java.lang.String sourceName) throws InvalidSessionException, AuthorizationException, ExtensionModuleNotFoundException, MetaMatrixComponentException
getSourceDescriptor
in interface ExtensionSourceAdminAPI
sourceName
- name (e.g. filename) of extension source
InvalidSessionException
- if there is not a valid administrative session
AuthorizationException
- if the administrator does not have privileges to use this method
ExtensionSourceNotFoundException
- if no extension source with
name sourceName can be found
MetaMatrixComponentException
- indicating a non-business-related
exception (such as a communication exception)
ExtensionModuleNotFoundException
@RolesAllowed(value="Admin.SystemAdmin") public java.util.List setSearchOrder(java.util.List sourceNames) throws InvalidSessionException, AuthorizationException, ExtensionModuleOrderingException, MetaMatrixComponentException
setSearchOrder
in interface ExtensionSourceAdminAPI
sourceNames
- Collection of String names of existing
extension sources whose search position is to be set
InvalidSessionException
- if there is not a valid administrative session
AuthorizationException
- if the administrator does not have privileges to use this method
ExtensionSourceOrderingException
- if the extension files could
not be ordered as requested because another administrator had
concurrently added or removed an extension file or files, or because
an indicated position is out of bounds.
MetaMatrixComponentException
- indicating a non-business-related
exception (such as a communication exception)
ExtensionModuleOrderingException
@RolesAllowed(value="Admin.SystemAdmin") public java.util.List setEnabled(java.util.Collection sourceNames, boolean enabled) throws InvalidSessionException, AuthorizationException, ExtensionModuleNotFoundException, MetaMatrixComponentException
setEnabled
in interface ExtensionSourceAdminAPI
sourceNames
- Collection of String names of existing
extension sources whose "enabled" status is to be setenabled
- indicates whether each extension source is enabled for
being searched or not (for convenience, a source can be disabled
without being removed)
InvalidSessionException
- if there is not a valid administrative session
AuthorizationException
- if the administrator does not have privileges to use this method
ExtensionSourceNotFoundException
- if no extension source with
name sourceName can be found
MetaMatrixComponentException
- indicating a non-business-related
exception (such as a communication exception)
ExtensionModuleNotFoundException
@RolesAllowed(value="Admin.SystemAdmin") public ExtensionModuleDescriptor setSource(java.lang.String sourceName, byte[] source) throws InvalidSessionException, AuthorizationException, ExtensionModuleNotFoundException, MetaMatrixComponentException
setSource
in interface ExtensionSourceAdminAPI
sourceName
- name (e.g. filename) of extension sourcesource
- actual contents of source
InvalidSessionException
- if there is not a valid administrative session
AuthorizationException
- if the administrator does not have privileges to use this method
ExtensionSourceNotFoundException
- if no extension source with
name sourceName can be found
MetaMatrixComponentException
- indicating a non-business-related
exception (such as a communication exception)
ExtensionModuleNotFoundException
@RolesAllowed(value="Admin.SystemAdmin") public ExtensionModuleDescriptor setSourceName(java.lang.String sourceName, java.lang.String newName) throws InvalidSessionException, AuthorizationException, ExtensionModuleNotFoundException, MetaMatrixComponentException
setSourceName
in interface ExtensionSourceAdminAPI
sourceName
- name (e.g. filename) of extension sourcenewName
- new name for the source
ExtensionSourceNotFoundException
- if no extension source with
name sourceName can be found
MetaMatrixComponentException
- indicating a non-business-related
exception (such as a communication exception)
InvalidSessionException
AuthorizationException
ExtensionModuleNotFoundException
@RolesAllowed(value="Admin.SystemAdmin") public ExtensionModuleDescriptor setSourceDescription(java.lang.String sourceName, java.lang.String description) throws InvalidSessionException, AuthorizationException, ExtensionModuleNotFoundException, MetaMatrixComponentException
setSourceDescription
in interface ExtensionSourceAdminAPI
sourceName
- name (e.g. filename) of extension sourcedescription
- (optional) description of the extension source.
null
can be passed in to indicate no description.
ExtensionSourceNotFoundException
- if no extension source with
name sourceName can be found
MetaMatrixComponentException
- indicating a non-business-related
exception (such as a communication exception)
InvalidSessionException
AuthorizationException
ExtensionModuleNotFoundException
public boolean isSourceExists(java.lang.String sourceName) throws InvalidSessionException, AuthorizationException, MetaMatrixComponentException
ExtensionSourceAdminAPI
isSourceExists
in interface ExtensionSourceAdminAPI
sourceName
- name (e.g. filename) of extension source
InvalidSessionException
AuthorizationException
MetaMatrixComponentException
com.metamatrix.platform.admin.api.ExtensionSourceAdminAPI#isSourceExists()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |