| Home >> All >> org >> apache >> turbine >> [ services Javadoc ] |
Page 1 2 3
• org.apache.turbine.services: Javadoc index of package org.apache.turbine.services.
Package Samples:
• org.apache.turbine.services.assemblerbroker.util: Assemblerbroker Service looks for action, screen, page, layout classes based on class fragments.
• org.apache.turbine.services.assemblerbroker.util.python: Assemblerbroker Service looks for action, screen, page, layout classes based on class fragments.
• org.apache.turbine.services.jsp.util: JSP Service is used to provide Turbine with a Java Server page (JSP) based view.
• org.apache.turbine.services.crypto.provider: Contains the Crypto Service providing you with a variety of Crypto algorithms.
• org.apache.turbine.services.assemblerbroker.util.java: The various lookup factories for the Assemblerbroker service.
• org.apache.turbine.services.intake.model: The intake service can validate user input from HTML forms.
• org.apache.turbine.services.intake.transform: The intake service can validate user input from HTML forms.
• org.apache.turbine.services.assemblerbroker: Contains the Service framework for Turbine.
• org.apache.turbine.services.avaloncomponent
• org.apache.turbine.services.cache
• org.apache.turbine.services.component
• org.apache.turbine.services.crypto
• org.apache.turbine.services.db
• org.apache.turbine.services.factory
• org.apache.turbine.services.intake
• org.apache.turbine.services.intake.validator
• org.apache.turbine.services.intake.xmlmodel
• org.apache.turbine.services.jsp
• org.apache.turbine.services.localization
• org.apache.turbine.services.jsp.tags
Classes:
• TurbineTemplateService: This service provides a method for mapping templates to their appropriate Screens or Navigations. It also allows templates to define a layout/navigations/screen modularization within the template structure. It also performs caching if turned on in the properties file. This service is not bound to a specific templating engine but we will use the Velocity templating engine for the examples. It is available by using the VelocityService. This assumes the following properties in the Turbine configuration: # Register the VelocityService for the "vm" extension. services.VelocityService.template.extension=vm ...
• TurbinePullService: This is the concrete implementation of the Turbine Pull Service. These are tools that are placed in the context by the service These tools will be made available to all your templates. You list the tools in the following way: tool.<scope>.<id> = <classname> <scope> is the tool scope: global, request, session, authorized or persistent (see below for more details) <id> is the name of the tool in the context You can configure the tools in this way: tool.<id>.<parameter> = <value> So if you find "global", "request", "session" or "persistent" as second ...
• UserPeerManagerConstants: Constants for configuring the various columns and bean properties for the used peer. Default is: security.torque.userPeer.class = org.apache.turbine.services.security.torque.om.TurbineUserPeer security.torque.userPeer.column.name = LOGIN_NAME security.torque.userPeer.column.id = USER_ID security.torque.userPeer.column.password = PASSWORD_VALUE security.torque.userPeer.column.firstname = FIRST_NAME security.torque.userPeer.column.lastname = LAST_NAME security.torque.userPeer.column.email = EMAIL security.torque.userPeer.column.confirm = CONFIRM_VALUE security.torque.userPeer.column.createdate = ...
• TurbineNonPersistentSchedulerService: Service for a cron like scheduler that uses the TurbineResources.properties file instead of the database. The methods that operate on jobs ( get,add,update,remove ) only operate on the queue in memory and changes are not reflected to the properties file which was used to initilize the jobs. An example is given below. The job names are the class names that extend ScheduledJob. services.SchedulerService.scheduler.jobs=scheduledJobName,scheduledJobName2 services.SchedulerService.scheduler.job.scheduledJobName.ID=1 services.SchedulerService.scheduler.job.scheduledJobName.SECOND=-1 services.SchedulerService.scheduler.job.scheduledJobName.MINUTE=-1 ...
• UIManager: UIManager.java Manages all UI elements for a Turbine Application. Any UI element can be accessed in any template using the $ui handle (assuming you use the default PullService configuration). So, for example, you could access the background colour for your pages by using $ui.bgcolor Questions: What is the best way to allow an application to be skinned. And how to allow the flexible altering of a particular UI element in certain parts of the template hierarchy. For example on one section of your site you might like a certain bgcolor, on another part of your site you might want another. How can be ...
• TurbineGlobalCacheService: This Service functions as a Global Cache. A global cache is a good place to store items that you may need to access often but don't necessarily need (or want) to fetch from the database everytime. A good example would be a look up table of States that you store in a database and use throughout your application. Since information about States doesn't change very often, you could store this information in the Global Cache and decrease the overhead of hitting the database everytime you need State information. The following properties are needed to configure this service: services.GlobalCacheService.classname=org.apache.turbine.services.cache.TurbineGlobalCacheService ...
• TurbineUploadService: This class is an implementation of UploadService . Files will be stored in temporary disk storage on in memory, depending on request size, and will be available from the org.apache.turbine.util.parser.ParameterParser as org.apache.commons.fileupload.FileItem s. This implementation of UploadService handles multiple files per single html widget, sent using multipar/mixed encoding type, as specified by RFC 1867. Use ParameterParser.getFileItems(String) > ParameterParser.getFileItems(String) 55 to acquire an array of org.apache.commons.fileupload.FileItem s associated with given html widget.
• SessionListener: This class is a listener for both session creation and destruction, and for session activation and passivation. It must be configured via your web application's web.xml deployment descriptor as follows for the container to call it: <listener> <listener-class> org.apache.turbine.session.SessionListener </listener-class> </listener> <listener> elemements can occur between <context-param> and <servlet> elements in your deployment descriptor. The sessionCreated(HttpSessionEvent) 55 callback will automatically add an instance of this listener to any newly created ...
• PullService: The Pull Service manages the creation of application tools that are available to all templates in a Turbine application. By using the Pull Service you can avoid having to make Screens to populate a context for use in a particular template. The Pull Service creates a set of tools, as specified in the TR.props file. These tools can have global scope, request scope, authorized or session scope (i.e. stored in user temp hashmap) or persistent scope (i.e. stored in user perm hashmap) The standard way of referencing these global tools is through the toolbox handle. This handle is typically $toolbox, ...
• TurbineBaseService: This class provides a Service implementation that Services used in Turbine are required to extend. The functionality provided in addition to BaseService functionality is recognizing objects used in early initialization of Services in Turbine, and passing them to appropriate convenience methods. These methods should be overriden to provide desired initialization functionality. Note! Remember to call setInit(true) after successful initialization. Note! If you need to use another Service inside your early initialization, remember to request initialization of that Service before using it: getServiceBroker().initClass("OtherService",data); ...
• ClassMapper: This mapper tries to map Template names to class names. If no direct match is found, it tries matches "upwards" in the package hierarchy until either a match is found or the root is hit. Then it returns the name of the default class from the TemplateEngineService. 1. about.directions.Driving <- direct matching the template to the class name 2. about.directions.Default <- matching the package, class name is Default 3. about.Default <- stepping up in the package hierarchy, looking for Default 4. Default <- Class called "Default" without package 5. VelocityScreen <- The class configured ...
• FileHandler: A Handler for use with the XML-RPC service that will deal with clients sending file to the server (Turbine application) and clients getting files from the server (Turbine application). 1) In the first case where the client sends a file to the server, the client has encoded the file contents and passes those encoded file contents on to the server: Client --------> encoded file contents -------------> Server The server must then decode the file contents and write the decoded file contents to disk. 2) In the second case where the client gets a file from the the server, the server has encoded the file ...
• TorqueGroup: This class represents a Group of Users in the system that are associated with specific entity or resource. The users belonging to the Group may have various Roles. The Permissions to perform actions upon the resource depend on the Roles in the Group that they are assigned. It is separated from the actual Torque peer object to be able to replace the Peer with an user supplied Peer (and Object) Certain Roles that the Users may have in the system are not related to any specific resource nor entity. They are assigned within a special group named 'global' that can be referenced in the code as Group.GLOBAL_GROUP_NAME ...
• TurbineAvalonComponentService: An implementation of AvalonComponentService which loads all the components given in the TurbineResources.properties File. For component which require the location of the application or context root, there are two ways to get it. Implement the Contextualizable interface. The full path to the correct OS directory can be found under the ComponentAppRoot key. The system property "applicationRoot" is also set to the full path of the correct OS directory. If you want to initialize Torque by using the AvalonComponentService, you must activate Torque at initialization time by specifying services.AvalonComponentService.lookup ...
• TurbineUpload: This is a facade class for UploadService . This class provides static methods that retrieve the configured (in TurbineResource.properties) implementation of UploadService and perform certain operations on it. It uses constants defined in UploadService interface for accessing the service's properties and default values for them.
• TurbineVelocityService: This is a Service that can process Velocity templates from within a Turbine Screen. It is used in conjunction with the templating service as a Templating Engine for templates ending in "vm". It registers itself as translation engine with the template service and gets accessed from there. After configuring it in your properties, it should never be necessary to call methods from this service directly. Here's an example of how you might use it from a screen: Context context = TurbineVelocity.getContext(data); context.put("message", "Hello from Turbine!"); String results = TurbineVelocity.handleRequest(context,"helloWorld.vm"); ...
• PermissionPeerManagerConstants: Constants for configuring the various columns and bean properties for the used peer. Default is: security.torque.permissionPeer.class = org.apache.turbine.services.security.torque.om.TurbinePermissionPeer security.torque.permissionPeer.column.name = PERMISSION_NAME security.torque.permissionPeer.column.id = PERMISSION_ID security.torque.permission.class = org.apache.turbine.services.security.torque.om.TurbinePermission security.torque.permission.property.name = Name security.torque.permission.property.id = PermissionId If security.torque.permission.class is unset, then the value of the constant ...
• TurbineMimeTypeService: The MimeType Service maintains mappings between MIME types and the corresponding file name extensions, and between locales and character encodings. The MIME type mappings can be defined in MIME type files located in user's home directory, Java home directory or the current class jar. The default mapping file is defined with the mime.type.file property. In addition, the service maintains a set of most common mappings. The charset mappings can be defined in property files located in user's home directory, Java home directory or the current class jar. The default mapping file is defined with the charset.file ...
• DefaultTurbineRunData: DefaultTurbineRunData is the default implementation of the TurbineRunData interface, which is distributed by the Turbine RunData service, if another implementation is not defined in the default or specified RunData configuration. TurbineRunData is an extension to RunData, which is an interface to run-rime information that is passed within Turbine. This provides the threading mechanism for the entire system because multiple requests can potentially come in at the same time. Thus, there is only one RunData implementation for each request that is being serviced. DefaultTurbineRunData implements the ...
• GroupPeerManagerConstants: Constants for configuring the various columns and bean properties for the used peer. Default is: security.torque.groupPeer.class = org.apache.turbine.services.security.torque.om.TurbineGroupPeer security.torque.groupPeer.column.name = GROUP_NAME security.torque.groupPeer.column.id = GROUP_ID security.torque.group.class = org.apache.turbine.services.security.torque.om.TurbineGroup security.torque.group.property.name = Name security.torque.group.property.id = GroupId If security.torque.group.class is unset, then the value of the constant CLASSNAME_DEFAULT from the configured Peer is used.
• TurbineLocalizationService: This class is the single point of access to all localization resources. It caches different ResourceBundles for different Locales. Usage example: LocalizationService ls = (LocalizationService) TurbineServices .getInstance().getService(LocalizationService.SERVICE_NAME); Then call one of four methods to retrieve a ResourceBundle: getBundle("MyBundleName") getBundle("MyBundleName", httpAcceptLanguageHeader) etBundle("MyBundleName", HttpServletRequest) getBundle("MyBundleName", Locale) etc.
• RolePeerManagerConstants: Constants for configuring the various columns and bean properties for the used peer. Default is: security.torque.rolePeer.class = org.apache.turbine.services.security.torque.om.TurbineRolePeer security.torque.rolePeer.column.name = ROLE_NAME security.torque.rolePeer.column.id = ROLE_ID security.torque.role.class = org.apache.turbine.services.security.torque.om.TurbineRole security.torque.role.property.name = Name security.torque.role.property.id = RoleId If security.torque.role.class is unset, then the value of the constant CLASSNAME_DEFAULT from the configured Peer is used.
• InitableBroker: Classes that implement this interface can act as a broker for Initable classes. Functionality provided by the broker includes: Maintaining a single instance of each Initable in the system. Early initialization of Initables during system startup. Late initialization of Initables before they are used. Providing instances of Initables to requesting parties. Maintainging dependencies between Initables during early initalization phases, including circular dependencies detection.
• BaseSecurityService: This is a common subset of SecurityService implementation. Provided functionality includes: methods for retrieving User objects, that delegates functionality to the pluggable implementations of the User interface. synchronization mechanism for methods reading/modifying the security information, that guarantees that multiple threads may read the information concurrently, but threads that modify the information acquires exclusive access. implementation of convenience methods for retrieving security entities that maintain in-memory caching of objects for fast access.
• JavaCrypt: Implements the normal java.security.MessageDigest stream cipers. Base64 strings returned by this provider are correctly padded to multiples of four bytes. If you run into interoperability problems with other languages, especially perl and the Digest::MD5 module, note that the md5_base64 function from this package incorrectly drops the pad bytes. Use the MIME::Base64 package instead. If you upgrade from Turbine 2.1 and suddently your old stored passwords no longer work, please take a look at the OldJavaCrypt provider for bug-to-bug compatibility. This provider can be used as the default crypto algorithm ...
| Home | Contact Us | Privacy Policy | Terms of Service |