Weblogic Authors: Yeshim Deniz, Elizabeth White, Michael Meiner, Michael Bushong, Avi Rosenthal

Related Topics: Weblogic

Weblogic: Article

Weblogic Workshop Java Controls and Extensibility Architecture

Weblogic Workshop Java Controls and Extensibility Architecture

One of the most exciting aspects of BEA WebLogic Workshop 8.1 is the ability for developers and ISVs to extend the Workshop development environment by developing custom Java Controls, IDE Extensions, application templates, or TagLibrary extensions. In this article we start with a brief overview of WebLogic Workshop 8.1 and then take a high-level tour of these extensibility points. This article has been assembled from several sources on the Workshop product team. Workshop extensions development kits are available at http://dev2dev.bea.com/products/wlworkshop81/

WebLogic Workshop 8.1 Overview
WebLogic Workshop 8.1 is the IDE and framework for creating J2EE applications for the BEA WebLogic Platform 8.1. It's optimized for all developers to rapidly create, test, and deploy Web applications, XML Web services, EJBs, portals, and business processes on BEA WebLogic Platform 8.1. Simply put, Workshop makes the hard things easy and the sophisticated things possible.

WebLogic Workshop is both an IDE and a runtime framework. Its visual development environment and programming model is based on intuitive concepts such as drag-and-drop controls, methods, and properties to enable event-based development, eliminating the need for developers to master complex J2EE APIs and object-oriented programming disciplines. The IDE produces standard Java files with additional annotations to specify the appropriate runtime application behavior. These annotations enable the Workshop runtime framework to automatically generate the J2EE infrastructure components, thereby abstracting the user from the low-level infrastructure plumbing that would otherwise be required.

The visual development environment produces standard Java files with additional annotations inserted by Workshop (for example, when the developer sets properties or adds controls) to specify the appropriate runtime application behavior. These annotations enable the Workshop runtime framework to automatically generate the J2EE infrastructure components, thereby abstracting the user from the low-level infrastructure plumbing that would otherwise be required.

Applications - whether they are Web services, Web applications, portals, or workflows - share a common process of assembling and wiring together components that encapsulate business logic or resources with additional code, workflow logic, personalization information, and so on. Application assembly and component reuse are key constructs within WebLogic Workshop.

WebLogic Workshop Extensibility Points
In addition to simplifying the creation of J2EE applications, Workshop offers a rich extensibility model for developers and ISVs to integrate their products and services directly into the development environment. Using Java Controls, Templates, IDE Extensions, and TagLibrary extensions, developers have broad flexibility in working with WebLogic Workshop. Some example Workshop extension and application integration ideas include:

  • Custom application designers and windows that reside in Workshop's IDE
  • Custom controls that interface with back-end resources including databases, systems, applications, and business logic
  • Tool bar icons and custom menus that launch external helper applications
  • New project and file types not native to Workshop
  • JSP Tag Library extensions for use in Web applications

    With this as the backdrop, let's look at these extensibility points in more detail.

    WebLogic Workshop 8.1 Java Controls
    BEA WebLogic Workshop Java Controls provide developers with the ability to easily connect with existing data, systems, applications, and business logic. Controls are visual components with events, methods, and properties that handle all of the details of connecting to an external resource or piece of business logic. Developers interact with controls by handling events, calling methods, and setting properties. In addition to the suite of built-in Controls (see Figure 1), Workshop 8.1 also makes the Controls model extensible so that all users (including ISVs) can build custom Controls that seamlessly plug into the Workshop integrated development environment.

    Creating Java Controls
    To create a custom Java Control, developers use familiar visual designers to specify the interface (i.e, the methods and events supported), set properties to dictate runtime behavior, and write the business logic using procedural Java code to implement these methods. Developers build the control(s) in a separate Workshop "Control Project" within an application. When the Control Project is built, all of the controls in the project are compiled into a single JAR file. This JAR is self-contained and can be moved to any other Workshop application by adding it to the application's Library folder.

    Workshop also helps guide the Control user through the tasks of configuring the Control's behavior and appearance within an application. Control authors can provide either a simple Swing-based JPanel wizard or a multistep wizard presenting a set of configuration choices in terms the user understands.

    Java Controls expose a set of simple properties by which a user can implement advanced runtime functionality such as asynchronous communication, security roles, life-cycle events, transaction support, and so on. Authors of custom controls have the freedom to populate the Properties sheet for the benefit of the controls' users.

    Packaging and Distributing Java Controls
    Controls are easily packaged and distributed as standard JAR files. Users consume controls by importing JARs into their application Library folder (see Figure 2). Controls then automatically appear on the design palette of the user, ready for incorporation into an application.

    Application and Project Templates
    WebLogic Workshop ships with a project and application template mechanism that is part of the application subsystem. Templates allow development teams to start with an appropriate architecture as part of the initial project structure by pre-populating an application or project with the required supporting files and resources (i.e., JSPs, EJBs, JAR files, images, etc.). They offer a way for system architects and ISVs to package and distribute best practices and starting points for developers.

    Templates are stored in the weblogic81\workshop\templates directory and are packaged as zip files. A template can be made up of Java Controls, EJBs, JSPs, images, and/or any other file. They are loaded into an IDE based on an XML template definition file. Template zip files are read the first time the New Application, New Project, Add Project, or Install menu is opened.

    Project Templates
    WebLogic Workshop supports two types of templates: application and project. A project template can be created for populating a single new or existing project of a specific project type within Workshop. A project template may also be extended by other project templates and referenced by application templates.

    Application Templates
    An application template can be used for populating a new or existing Workshop application. Application templates can contain any number of elements, including project templates. Project templates defined inside the application template will not appear in the New Project and Add Project dialog and may only be used when creating this application.

    Listing 1 is an example of the template definition file associated with creating Web applications.

    WebLogic Workshop 8.1 IDE Extensions
    There are several levels of depth by which to extend and integrate with WebLogic Workshop's IDE; from simple tool bar icons that launch external applications to fully integrated applications with custom windows, menus, and property sheets.

    A Workshop extension is composed of the following artifacts, packaged together as a JAR or directory.

  • XML descriptor: extension.xml
  • Set of Java classes: Exposing interfaces, and consuming various services
  • Resource files: Images and string property files
  • Documentation

    WebLogic Workshop itself is the culmination of several extensions pulled together into one common interface. wlw-ide.JAR is the main Workshop executable, containing the core class files, utility classes, and the mechanism to load extensions, but the interesting code to run the IDE is contained in the required Workshop extensions. WebLogic Workshop defines two types of extensions: required and optional. Required Workshop extensions are:

  • Control
  • Debugger
  • JSP Designer
  • Shell
  • Source control
  • Workspace
  • XML
  • Source editor

    Optional extensions include

  • Pageflow
  • Process

    To cause Workshop to load a specific extension at startup, the extension's JAR file is placed in the extensions' subdirectory below the directory containing the wlw-ide.JAR file that contains the IDE core. An extension may also be fully exploded to directories and class files in the "extensions" subdirectory.

    Creating Workshop Extensions
    A WebLogic Workshop extension is simply defined as a JAR or a directory that contains at a minimum the extensions.xml, the file that declares an extension's participation in the IDE. By creating a JAR file with the extensions.xml file shown in Listing 2 , we can add a new tool bar icon to Workshop. It's that easy.

    The % signs in "%sqlEditor.extension.actionSQLAttributeEditor%" are a means of referring to a localizable string resource and that it's optional.

    This extension places a new button on the toolbar with database.gif as its icon. When the new toolbar button is pressed, the SQLAttributeEditor is displayed.

    For more complex extensions, the JAR file would contain the Java code that is the extension's implementation, a manifest file that defines the class path, and attributes that reference dependent JARs that need to be available at runtime by the extension.

    At startup, the core IDE runtime reads all the extension.xml files, batches them together and ensures that the requested services by each extension are available.

    Extensions may define handlers for the <extension-xml> tag found in the extension.xml file. Handlers are associated with a particular id attribute. All extension.xml files are scanned for fragments contained within the <extension-xml> tag and those fragments are passed to handlers defined for the particular id attribute. This mechanism allows extensions to create extendable infrastructure in which other extensions can participate. The handler class is instantiated by the core IDE and is completely responsible for parsing the xml contained in the fragment.

    One important aspect of an extension is its ability to expose and consume the various IDE services. A service is essentially a public interface that has a single instance implementation and provides access to functionality in an extension. In addition to handlers for <extension-xml> tags, an extension may declare services that it implements. For instance, the debugger extension defines a debugger service that, among other things, provides a method for setting a breakpoint. The shell provides a document service with a method for opening a document. Services are consumed by the extensions Java classes and registered with the system using special tags in the extensions.xml file. Many services have associated tag handlers that allow extensions to add functionality to the service. Some of the most widely used services include:

  • Resource Service: Provides access to resources such as icons, images, and localizable strings
  • Frame Service: Allows extensions to specify the extensions docking layout
  • File Service: Provides a set of services for file system access and manipulation
  • Server Service: Provides a set of services for accessing the WebLogic Server
  • Document Service: Provides a means to supply an abstract document interface for files that are part of the application project.
  • Action Service: Provides methods for adding and manipulating menu and toolbar items

    Custom Tag Library Extensions
    Tag Library Definition Extension (tldx) files allow developers to integrate their tags into Workshop. Integration services provided by the IDE allow developers access to both the data palette and design palette, error checking in source view, and custom rendering of their tags in the JSP Designer.

    To build custom tag libraries for WebLogic Workshop, developers supply a tld/tldx pair, a tag handler JAR, and a tldx handler JAR (currently the tldx JAR must live in the workshop/extensions directory). Associated Help documents may be placed in WebLogic Workshop's Help directory.

    BEA WebLogic Workshop 8.1 offers a rich extensibility model for developers and ISVs to integrate their products and services directly into the development environment.

  • More Stories By Dave Cotter

    Dave Cotter is a director of product management on the WebLogic Workshop product team.

    Comments (0)

    Share your thoughts on this story.

    Add your comment
    You must be signed in to add a comment. Sign-in | Register

    In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.

    IoT & Smart Cities Stories
    The deluge of IoT sensor data collected from connected devices and the powerful AI required to make that data actionable are giving rise to a hybrid ecosystem in which cloud, on-prem and edge processes become interweaved. Attendees will learn how emerging composable infrastructure solutions deliver the adaptive architecture needed to manage this new data reality. Machine learning algorithms can better anticipate data storms and automate resources to support surges, including fully scalable GPU-c...
    Machine learning has taken residence at our cities' cores and now we can finally have "smart cities." Cities are a collection of buildings made to provide the structure and safety necessary for people to function, create and survive. Buildings are a pool of ever-changing performance data from large automated systems such as heating and cooling to the people that live and work within them. Through machine learning, buildings can optimize performance, reduce costs, and improve occupant comfort by ...
    The explosion of new web/cloud/IoT-based applications and the data they generate are transforming our world right before our eyes. In this rush to adopt these new technologies, organizations are often ignoring fundamental questions concerning who owns the data and failing to ask for permission to conduct invasive surveillance of their customers. Organizations that are not transparent about how their systems gather data telemetry without offering shared data ownership risk product rejection, regu...
    René Bostic is the Technical VP of the IBM Cloud Unit in North America. Enjoying her career with IBM during the modern millennial technological era, she is an expert in cloud computing, DevOps and emerging cloud technologies such as Blockchain. Her strengths and core competencies include a proven record of accomplishments in consensus building at all levels to assess, plan, and implement enterprise and cloud computing solutions. René is a member of the Society of Women Engineers (SWE) and a m...
    Poor data quality and analytics drive down business value. In fact, Gartner estimated that the average financial impact of poor data quality on organizations is $9.7 million per year. But bad data is much more than a cost center. By eroding trust in information, analytics and the business decisions based on these, it is a serious impediment to digital transformation.
    Digital Transformation: Preparing Cloud & IoT Security for the Age of Artificial Intelligence. As automation and artificial intelligence (AI) power solution development and delivery, many businesses need to build backend cloud capabilities. Well-poised organizations, marketing smart devices with AI and BlockChain capabilities prepare to refine compliance and regulatory capabilities in 2018. Volumes of health, financial, technical and privacy data, along with tightening compliance requirements by...
    Predicting the future has never been more challenging - not because of the lack of data but because of the flood of ungoverned and risk laden information. Microsoft states that 2.5 exabytes of data are created every day. Expectations and reliance on data are being pushed to the limits, as demands around hybrid options continue to grow.
    Digital Transformation and Disruption, Amazon Style - What You Can Learn. Chris Kocher is a co-founder of Grey Heron, a management and strategic marketing consulting firm. He has 25+ years in both strategic and hands-on operating experience helping executives and investors build revenues and shareholder value. He has consulted with over 130 companies on innovating with new business models, product strategies and monetization. Chris has held management positions at HP and Symantec in addition to ...
    Enterprises have taken advantage of IoT to achieve important revenue and cost advantages. What is less apparent is how incumbent enterprises operating at scale have, following success with IoT, built analytic, operations management and software development capabilities - ranging from autonomous vehicles to manageable robotics installations. They have embraced these capabilities as if they were Silicon Valley startups.
    As IoT continues to increase momentum, so does the associated risk. Secure Device Lifecycle Management (DLM) is ranked as one of the most important technology areas of IoT. Driving this trend is the realization that secure support for IoT devices provides companies the ability to deliver high-quality, reliable, secure offerings faster, create new revenue streams, and reduce support costs, all while building a competitive advantage in their markets. In this session, we will use customer use cases...