| Home >> All >> org >> apache >> slide |
Page 1 2
Package Samples:
• org.apache.slide.jaas.spi
• org.apache.slide.authenticate
• org.apache.slide.cluster
• org.apache.slide.common
• org.apache.slide.content
• org.apache.slide.event
• org.apache.slide.extractor
• org.apache.slide.lock
• org.apache.slide.macro
• org.apache.slide.index
Classes:
• JNDIPrincipalStore: This is a read-only Store implementation for retrieving Slide users and roles from an LDAP server. It has been tested with Novell's eDirectory version 8.6.2. Other LDAP servers should work. Prerequisites To use this Store your app server must be setup to authenticate users using the LDAP server. For Tomcat 5 see this . You cannot use the SlideRealm to authenticate users because this Store does not expose a password property. Store Parameters Parameters used in Domain.xml when setting up the Store. cache.refresh.checkrate How often, in seconds , the cache refresh thread should check for Uris in ...
• ClusterCacheRefresher: Description When configured properly this class will register with one or more external Slide instances and listen for changes. Upon notification of a change this class will cause the cache of the local Slide instance to be refreshed for the changed object. Usage Add the following to your Domain.xml inside the <events> node. <listener classname="org.apache.slide.cluster.ClusterCacheRefresher"> <configuration> <node local-host="local.host.domain" local-port="4444" repository-host="remote.host.domain" repository-port="8080" repository-protocol="http" ...
• Domain: The Domain controls access to its registered namespaces and performs initialization and connection management on behalf of the namespaces. From the client application's perspective, the domain represents the only directly accessible object. It is through this object that the client gains access to namespaces, using the static method Domain.accessNamespace() . Since the domain acts as the root of a directory service, it is a static entity and there can be only one domain per JVM. Initialization When Slide is first initialized, the Domain configuration is loaded. The location of the domain configuration ...
• ContentInterceptor: An interface that allows custom components to observe and intercept storage, retrieval and removal of content. Multiple ContentInterceptors can be associated with a single Namespace . They are typically configured in the <configuration> section of the domain configuration file like this: <content-interceptor class="com.acme.MyContentInterceptor"> <parameter name="myParam1">someValue</parameter> <parameter name="myParam2">anotherValue</parameter> </content-interceptor> As you can see, ContentInterceptors can be configured ...
• Namespace: A Namespace contains a hierarchically organized tree of information. Objects in the namespace are generally referred to as Nodes . Nodes may have a parent, children, content and meta-data. They can also be versioned (so that multiple revisions of the object's content and metadata are stored) and locked (so that only specific principals are allowed to read or modify the object). In addition, access control information can be assigned to every node. Nodes in the hierarchy are identified by their URI (Unique Resource Identifier). A URI is analogous to a file path in traditional file systems. For example: ...
• NotNormalizer: This class recursivly removes all <not> expressions and replaces their successors by appropriate negated expressions. Since an example explains more than a thousand words: <D:not> <D:or> <D:lt> <D:prop> <D:getcontentlength> </D:prop> <D:literal>1000</D:literal> </D:lt> <D:eq> <D:prop> <D:getcontenttype> </D:prop> <D:literal>text/xml</D:literal> </D:eq> </D:or> </D:not> will be transformed to <D:and> <D:not-lt> <D:prop> <D:getcontentlength> </D:prop> <D:literal>1000</D:literal> ...
• AbstractTransientStore: Base class for the stores that what to store its data transient in a map. Implementations access the backing map only via put(Object, Object) 55 , get(Object) 55 and remove(Object) 55 . The backed map can be any class that is derived from org.apache.commons.transaction.memory.TransactionalMapWrapper . The class may be configured in the domain.xml using the parameter map-classname . Default is org.apache.commons.transaction.memory.OptimisticMapWrapper .
• OldJDBCAdapter: A database adapter, which is using almost the same SQL scheme as the deprecated slidestore.reference.JDBCDescriptorsStore. This adapter this meant for backward compatibility with Slide 1.x. Don't use this adapter for new projects. The content store methods are not supported. This adapter requires a minor change of table locks. It should look like this (Postgres dialect, adapt it for your database): create table locks(id varchar(4000), object varchar(4000), subject varchar(4000), type varchar(4000), expirationdate varchar(15), inheritable int, xexclusive int, ownerinfo varchar(255)); You may overide ...
• ByteSizeLimitedObjectCache: Transactional LRU byte counting object cache. Caches objects using a least-recently-used strategy. Asserts a given overall size of all cached objects does not exceed a specified limit. It provides basic isolation from other transactions and atomicity of all operations. As no locking is used (which is undesirable mainly as a cache should never block and a commit must never fail) serializability needs to be guaranteed by underlying stores. Note : Unlike TxLRUObjectCache this cache also limits the size of temporary caches inside transactions. This is necessary as size of bytes in a transaction can ...
• SlideToken: The SlideToken interface identifies the current acting principal and its credentials, and maintains information about the state of the user transaction. An object implementing this interface is required to use any of the methods provided by the helpers API. The default implementation of this interface is SlideTokenImpl . In the context of a Java servlet, such an object should be instantiated like this: Principal principal = request.getUserPrincipal(); CredentialsToken credentials; if (principal == null) { credentials = new CredentialsToken(""); } else { credentials = new CredentialsToken(principal); ...
• TxLRUObjectCache: Transactional LRU object cache. Caches objects using a least-recently-used strategy. It provides basic isolation from other transactions and atomicity of all operations. As no locking is used (which is undesirable mainly as a cache should never block and a commit must never fail) serializability needs to be guaranteed by underlying stores. Caution : Only global caches are limited by given size. Size of temporary data inside a transaction is unlimited. Note : This cache has no idea if the data it caches in transactions are read from or written to store. It thus handles both access types the same ...
• NamespaceAccessToken: The NamespaceAccessToken is an interface used to completely hide the real Namespace object reference from the client application. It is used by Slide to authenticate and control any operations on the namespace. Using the NamespaceAccessToken, the application can obtain access to the helper interfaces ( Content , Lock , Macro , Security and Structure ). The NamespaceAccessToken object implements the UserTransaction interface (see the Java Transaction API documentation for more details) to allow the client to control transaction demarcation.
• PropertyProvider: If a PropertyProvider is passed to Search.createSearchQuery() 55 , the Search helper must not access any of the properties supported by this PropertyProvider 55 directly (e.g. by using the Content helper) but instead use getProperty() 55 on this provider to retrieve it.
• Configuration: Provides default configuration for Slide components from the slide.properties configuration file. All slide features rely on the central configuration file. The configuration file is loaded from the Java lib directory, the classpath and the Castor JAR. Properties set in the classpath file takes precedence over properties set in the Java library configuration file and properties set in the Slide JAR, allowing for each customization. All three files are named slide.properties . For example, to change the domain init file in use, create a new configuration file in the current directory, instead of ...
• NoCacheFilter: A simple filter that ensures the two HTTP cache headers (Pragma and Cache-Control) are set to values that will allow Internet Explorer to display non-inline files (.pdf, .doc, etc) when using an SSL connection. This is to work around a bug in IE versions 5.01 through 6. This class is designed for use in an intranet environment where the security ramifications are controllable. In a public environment something more advanced should be used. Setting Cache-Control to "private" and sniffing the request to make sure the headers need to be modified might be enough.
• ComparableResource: Represents one item of a searcheable set. One item is identified with a unique URI. A RequestedItem may be compared against a property represented by property name and value (as String). These compare methods (equals(), greaterThan(), ...) use three valued logic (TRUE, FALSE, UNKNOWN). UNKNOWN is returned when this item does not know the property to compare against or when the value of that property may not be converted to the datatype of this items matching property (for example comparing a Float against the string "foo"). TODO: Namespace awareness!!
• Configuration: Configuration is a interface encapsulating a configuration node used to retrieve configuration values. This is a "read only" interface preventing applications from modifying their own configurations. The contract surrounding the Configuration is that once it is created, information never changes. The Configuration is built by the SAXConfigurationBuilder and the ConfigurationImpl helper classes.
• XByteBuffer: Un-synchronized byte buffer. We have methods to write and read from the buffer, and helpers can convert various data formats. The idea is to minimize the number of buffers and the amount of copy from layer to layer. It's _not_ premature optimization - it's the way things should work. The Request and Response will use several buffers, same for the protocol adapters. Note that the Buffer owns his byte[], while the Chunk is just a light cursor.
• AbstractContentInterceptor: Provides a basic implementation of the ContentInterceptor interface. This implementation does nothing but store the parameters and the NamespaceAccessToken, and provide empty implementations of the various hook methods. You can extend this class instead of implementing the ContentInterceptor interface directly, and only override the methods required for your specific interceptor to operate.
• XServletWriterFacade: Facade to the PrintWriter returned by Response. This will grow to include more support for JSPs ( and other templating systems ) buffering requirements, provide support for accounting and will allow more control over char-to-byte conversion ( if it proves that we spend too much time in that area ). This will also help us control the multi-buffering ( since all writers have 8k or more of un-recyclable buffers).
• SlideUri: A SlideUri contains two parts the context path and the slide uri . The context path is determined by the path of the webapp and the path to which the WebDavServlet is mapped. Samples: /slide , /webapp/webdav and / . The slide uri is an URI as represented by org.apache.slide.common.Uri .
• ResourceId: Uniquely identifies a resource. The main operation with ResourceIds is equals. Immutable. Technically, ResourceId extends Uri, but the only reason to do so is compatibility with existing store interfaces. Logically, a ResourceId is *not* an Uri: Uris have a structure, resourceId have not. Consequently, almost all Uri methods in this class throw UnsupportedOperation exceptions.
• ObjectCache: Object cache interface. Interface to an object cache to the objects manipulated by Slide. This includes : Uri objects Object nodes Revision descriptors Permissions Locks The implementation of this interface is free to provide any kind of algorithm to limit cache size, like dropping LRU elements.
• SlideLoginModule: JAAS LoginModule for authenticating against users in a Slide namespace. The implementation assumes the ACLSecurityImpl is used. Options include (to be specified in JAAS login configuration file): namespace : the namespace to load users from. Defaults to the default namespace from the Slide domain configuration.
• PropertyRetriever: An implementation of this interface is used to retrieve the properties of a resource as a list of <propstat> elements. The main code of this class has been copied from the PropFindMethod . All methods providing property information ( PropFindMethod , ReportMethod ) should use an implementation of this interface.
| Home | Contact Us | Privacy Policy | Terms of Service |