Package org.nuxeo.ecm.webengine.model

Interface Resource

All Superinterfaces:

Adaptable

All Known Subinterfaces:

AdapterResource, ModuleResource

All Known Implementing Classes:

AbstractResource, AbstractResourceService, AbstractResourceService, AbstractUMObject, AbstractUMRootObject, ACLAdapter, AnnotationAdapter, APIRoot, AsyncOperationAdapter, AuditAdapter, AuditService, AuthenticationTokensObject, AutomationResource, BaseUMObject, BatchUploadObject, BinariesObject, BlobAdapter, BlobObject, BOAdapter, BulkActionFrameworkObject, BulkActionObject, BulkDocumentsObject, BulkObject, CapabilitiesObject, ChildrenAdapter, CommentAdapter, CommentService, ConfigEndPoint, ConnectClientRoot, ConversionRootObject, ConvertAdapter, DebugResource, DefaultAdapter, DefaultObject, DirectoryEntryObject, DirectoryObject, DirectoryRootObject, DistributionObject, DocObject, DocResource, DocTypeEndPoint, DocumentModelListPaginableAdapter, DocumentObject, DocumentResolverService, DocumentRoot, DownloadHandler, EasyShare, ElasticsearchObject, EmptyDocumentAdapter, ExecutableResource, FacetEndPoint, FilesEndpoint, FileService, GroupMemberGroupsAdapter, GroupMemberUsersAdapter, GroupObject, GroupRootObject, InstallHandler, JSONDocumentObject, LockService, Main, Main, ManagementObject, MeObject, MigrationObject, ModuleRoot, NuxeoDriveObject, OAuth2Callback, OAuth2Object, OperationAdapter, OperationResource, PackageListingProvider, PageProviderAdapter, PaginableAdapter, PaginableObject, PermissionService, PicturesObject, PreviewAdapter, ProbesObject, QueryExecutor, QueryObject, RemoveHandler, RenditionAdapter, RenditionObject, RepositoryObject, ResourceBundleEndpoint, ResourceService, ResourceService, RootResource, RootResource, SchemaEndPoint, SCIMGroupWebObject, SCIMRoot, SCIMUserWebObject, SearchAdapter, SearchObject, StreamObject, TargetPlatformObject, TaskAdapter, TaskObject, TemplateBasedResource, TemplateResource, Test, ThumbnailsObject, UninstallHandler, UserInvitationObject, UserObject, UserRootObject, UserToGroupObject, VersionService, ViewService, WebForm, Wizard, WOPIRoot, WorkflowAdapter, WorkflowModelObject, WorkflowObject, WorkManagerObject, XDocReportResourceService

public interface Resource
extends Adaptable

Author:

Bogdan Stefanescu

Method Summary

Modifier and Type	Method	Description
boolean	checkGuard(String guard)	Checks the given guard expression in the context of this resource.
void	dispose()
AdapterResource	getActiveAdapter()	Returns the active Adapter on this object if any in the current request.
WebContext	getContext()
Set<String>	getFacets()
List<LinkDescriptor>	getLinks(String category)
Module	getModule()
String	getName()
Resource	getNext()
String	getNextSegment()
String	getPath()
Resource	getPrevious()
Template	getTemplate(String fileName)
String	getTrailingPath()
ResourceType	getType()
String	getURL()
Template	getView(String viewId)
boolean	hasFacet(String facet)
Resource	initialize(WebContext ctx, ResourceType type, Object... args)
boolean	isAdapter()
boolean	isInstanceOf(String type)
boolean	isRoot()
AdapterResource	newAdapter(String type, Object... args)
Resource	newObject(String type, Object... args)
javax.ws.rs.core.Response	redirect(String uri)
void	setNext(Resource next)
void	setPrevious(Resource previous)
void	setRoot(boolean isRoot)

Methods inherited from interface org.nuxeo.runtime.model.Adaptable

getAdapter

Method Detail

initialize

Resource initialize(WebContext ctx,
                    ResourceType type,
                    Object... args)

dispose

void dispose()

getContext

WebContext getContext()

getModule

Module getModule()

getType

ResourceType getType()

isInstanceOf

boolean isInstanceOf(String type)

getName

String getName()

getPath

String getPath()

getTrailingPath

String getTrailingPath()

getNextSegment

String getNextSegment()

getURL

String getURL()

getPrevious

Resource getPrevious()

getNext

Resource getNext()

setNext

void setNext(Resource next)

setPrevious

void setPrevious(Resource previous)

isAdapter

boolean isAdapter()

isRoot

boolean isRoot()

setRoot

void setRoot(boolean isRoot)

getFacets

Set<String> getFacets()

hasFacet

boolean hasFacet(String facet)

getLinks

List<LinkDescriptor> getLinks(String category)

newObject

Resource newObject(String type,
                   Object... args)

newAdapter

AdapterResource newAdapter(String type,
                           Object... args)

getView

Template getView(String viewId)

getTemplate

Template getTemplate(String fileName)

redirect

javax.ws.rs.core.Response redirect(String uri)

getActiveAdapter

AdapterResource getActiveAdapter()

Returns the active Adapter on this object if any in the current request.

Returns:

the service instance or null

checkGuard

boolean checkGuard(String guard)
            throws ParseException

Checks the given guard expression in the context of this resource.

Throws:

ParseException