|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Module
Method Summary | |
---|---|
void |
flushCache()
|
java.util.List<LinkDescriptor> |
getActiveLinks(Resource context,
java.lang.String category)
|
AdapterType |
getAdapter(Resource ctx,
java.lang.String name)
Gets the named adapter definition for the given resource. |
java.util.List<java.lang.String> |
getAdapterNames(Resource ctx)
Gets the list of adapter names that applies to the given resource. |
AdapterType[] |
getAdapters()
Gets the adapters registered within this module. |
java.util.List<AdapterType> |
getAdapters(Resource ctx)
Gets the list of adapters that applies to the given resource. |
java.util.List<java.lang.String> |
getEnabledAdapterNames(Resource ctx)
Gets the list of adapter names that are enabled for the given context. |
java.util.List<AdapterType> |
getEnabledAdapters(Resource ctx)
Gets the list of adapters that are enabled for the given context. |
WebEngine |
getEngine()
|
ScriptFile |
getFile(java.lang.String path)
Gets a file using the configured directory stack. |
java.util.List<LinkDescriptor> |
getLinks(java.lang.String category)
|
java.lang.String |
getMediaTypeId(javax.ws.rs.core.MediaType mt)
|
Messages |
getMessages()
|
java.util.Map<java.lang.String,java.lang.String> |
getMessages(java.lang.String language)
|
java.lang.String |
getName()
|
java.util.List<ResourceBinding> |
getResourceBindings()
|
java.io.File |
getRoot()
|
Resource |
getRootObject(WebContext ctx)
|
java.lang.String |
getSkinPathPrefix()
Get the path prefix to be used from templates to prepend to links to static resources. |
ScriptFile |
getSkinResource(java.lang.String path)
Gets a skin resource input stream. |
Module |
getSuperModule()
|
java.lang.String |
getTemplateFileExt()
|
ResourceType |
getType(java.lang.String typeName)
Gets a ResourceType instance given its name. |
ResourceType[] |
getTypes()
Gets the types registered within this module. |
Validator |
getValidator(java.lang.String docType)
|
boolean |
isDerivedFrom(java.lang.String moduleName)
|
java.lang.Class<?> |
loadClass(java.lang.String className)
Loads a class given its name. |
Method Detail |
---|
java.lang.String getName()
java.io.File getRoot()
Resource getRootObject(WebContext ctx)
WebEngine getEngine()
void flushCache()
Module getSuperModule()
java.lang.String getTemplateFileExt()
java.lang.String getMediaTypeId(javax.ws.rs.core.MediaType mt)
java.util.Map<java.lang.String,java.lang.String> getMessages(java.lang.String language)
getMessages
in interface MessagesProvider
Messages getMessages()
java.util.List<ResourceBinding> getResourceBindings()
ScriptFile getFile(java.lang.String path)
Note that the implementation may cache the results. To clear any cached
data, you should call the flushCache()
method.
path
- the file path
ScriptFile getSkinResource(java.lang.String path) throws java.io.IOException
java.io.IOException
java.lang.Class<?> loadClass(java.lang.String className) throws java.lang.ClassNotFoundException
The scripting class loader will be used to load the class.
className
- the class name
java.lang.ClassNotFoundException
ResourceType getType(java.lang.String typeName)
ResourceType
instance given its name.
The web type lookup is performed in the following order:
typeName
- the type name
TypeNotFoundException
- if no such web type was definedResourceType[] getTypes()
AdapterType[] getAdapters()
AdapterType getAdapter(Resource ctx, java.lang.String name)
ctx
- the target resourcename
- the adapter name
WebSecurityException
- if the adapter exists but cannot be accessed in the context of that resource
AdapterNotFoundException
- if no such adapter exists for that resourcejava.util.List<AdapterType> getAdapters(Resource ctx)
ctx
- the context resource
java.util.List<java.lang.String> getAdapterNames(Resource ctx)
ctx
- the context resource
java.util.List<AdapterType> getEnabledAdapters(Resource ctx)
Enabled adapters are those adapters which can be accessed in the current security context.
ctx
- the context resource
java.util.List<java.lang.String> getEnabledAdapterNames(Resource ctx)
Enabled services are those adapters which can be accessed in the current security context.
ctx
- the context resource
java.util.List<LinkDescriptor> getLinks(java.lang.String category)
java.util.List<LinkDescriptor> getActiveLinks(Resource context, java.lang.String category)
java.lang.String getSkinPathPrefix()
This prefix is exposed to templates as ${skinPath}.
boolean isDerivedFrom(java.lang.String moduleName)
Validator getValidator(java.lang.String docType)
|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |