scriptella.spi

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Natural Language Processing
51.Net
52.Parser
53.PDF
54.Portal
55.Profiler
56.Project Management
57.Report
58.RSS RDF
59.Rule Engine
60.Science
61.Scripting
62.Search Engine
63.Security
64.Sevlet Container
65.Source Control
66.Swing Library
67.Template Engine
68.Test Coverage
69.Testing
70.UML
71.Web Crawler
72.Web Framework
73.Web Mail
74.Web Server
75.Web Services
76.Web Services apache cxf 2.2.6
77.Web Services AXIS2
78.Wiki Engine
79.Workflow Engines
80.XML
81.XML UI
Java Source Code / Java Documentation  » Scripting » scriptella » scriptella.spi 
scriptella.spi
Service Provider Interface classes.

Service Provider Requirements

Although Scriptella supports any JDBC Driver through JDBC Bridge, writing a custom Provider may be easier and more effective. The requirements for Service Provider are minimal:

Driver Registration

No special steps are required to register Scriptella Provider. Simply specify driver class name in a driver attribute of <connection> element. Examples:
    <connection driver="provider.class.name" url="provider:url"/>
You may also specify a driver's classpath. Classpath URIs are resolved relative to an ETL file:
    <connection driver="provider.class.name" url="provider:url" classpath="driver.jar;lib/driver-addons.jar"/>
In this case the driver is loaded using a separate classloader

Driver Alias

Putting a driver into scriptella.driver.SHORT_NAME package and specifying "Driver" as a class name automatically allows referencing the driver by a SHORT_NAME alias.
Example:
<connection driver="SHORT_NAME">
loads scriptella.driver.SHORT_NAME.Driver class.

Additional Recommendations

  • url is not a required attribute for custom providers, nevertheless it may make sense to specify URL protocol for your driver.
  • If your solution performs scripts compilation and this procedure is expensive, use caching based on Resource indentities as described in javadoc for Connection.
  • Pack your provider as a JAR file setting specification title, version and other attributes in manifest. Adding a simple readme file inside a JAR may help users to quickly get how to use it.
  • Scriptella built-in drivers can be used as a reference implementation to create a new driver.
Java Source File NameTypeComment
AbstractConnection.javaClass A base class for connections.
AbstractScriptellaDriver.javaClass An abstract base for Scriptella drivers.
Connection.javaInterface Represents a connection to the system provided by ScriptellaDriver .
ConnectionParameters.javaClass Represents connection parameters.
ConnectionParametersTest.javaClass Tests for ConnectionParameters .
DialectIdentifier.javaClass Represents vendor dialect information.
DriverContext.javaInterface Global ETL Context available to drivers.
IndexedQueryCallback.javaClass Query callback implementation which supports indexing.
MockConnectionParameters.javaClass Mock implementation of scriptella.spi.ConnectionParameters .
MockDriverContext.javaClass Mock implementation of drivers context suitable for typical cases.
MockParametersCallbacks.javaClass Set of common implementations for testing.
ParametersCallback.javaInterface Callback interface to obtain parameter values.
ProviderException.javaClass Thrown by connection provider to indicate any kind of failure.
QueryCallback.javaInterface Callback interface for query result set iteration.
Resource.javaInterface Represents reference to a text resource capable of creating new readers.
ScriptellaDriver.javaInterface Service Provider Interface for integrating third-party systems with Scriptella.
w___w__w__.__j___a___v___a__2__s.__com___ | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.