Welcome!

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.

    Services
    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.

    Conclusion
    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.


    @ThingsExpo Stories
    Leading companies, from the Global Fortune 500 to the smallest companies, are adopting hybrid cloud as the path to business advantage. Hybrid cloud depends on cloud services and on-premises infrastructure working in unison. Successful implementations require new levels of data mobility, enabled by an automated and seamless flow across on-premises and cloud resources. In his general session at 21st Cloud Expo, Greg Tevis, an IBM Storage Software Technical Strategist and Customer Solution Architec...
    Nordstrom is transforming the way that they do business and the cloud is the key to enabling speed and hyper personalized customer experiences. In his session at 21st Cloud Expo, Ken Schow, VP of Engineering at Nordstrom, discussed some of the key learnings and common pitfalls of large enterprises moving to the cloud. This includes strategies around choosing a cloud provider(s), architecture, and lessons learned. In addition, he covered some of the best practices for structured team migration an...
    Product connectivity goes hand and hand these days with increased use of personal data. New IoT devices are becoming more personalized than ever before. In his session at 22nd Cloud Expo | DXWorld Expo, Nicolas Fierro, CEO of MIMIR Blockchain Solutions, will discuss how in order to protect your data and privacy, IoT applications need to embrace Blockchain technology for a new level of product security never before seen - or needed.
    Imagine if you will, a retail floor so densely packed with sensors that they can pick up the movements of insects scurrying across a store aisle. Or a component of a piece of factory equipment so well-instrumented that its digital twin provides resolution down to the micrometer.
    In his keynote at 18th Cloud Expo, Andrew Keys, Co-Founder of ConsenSys Enterprise, provided an overview of the evolution of the Internet and the Database and the future of their combination – the Blockchain. Andrew Keys is Co-Founder of ConsenSys Enterprise. He comes to ConsenSys Enterprise with capital markets, technology and entrepreneurial experience. Previously, he worked for UBS investment bank in equities analysis. Later, he was responsible for the creation and distribution of life settle...
    BnkToTheFuture.com is the largest online investment platform for investing in FinTech, Bitcoin and Blockchain companies. We believe the future of finance looks very different from the past and we aim to invest and provide trading opportunities for qualifying investors that want to build a portfolio in the sector in compliance with international financial regulations.
    No hype cycles or predictions of a gazillion things here. IoT is here. You get it. You know your business and have great ideas for a business transformation strategy. What comes next? Time to make it happen. In his session at @ThingsExpo, Jay Mason, an Associate Partner of Analytics, IoT & Cybersecurity at M&S Consulting, presented a step-by-step plan to develop your technology implementation strategy. He also discussed the evaluation of communication standards and IoT messaging protocols, data...
    Coca-Cola’s Google powered digital signage system lays the groundwork for a more valuable connection between Coke and its customers. Digital signs pair software with high-resolution displays so that a message can be changed instantly based on what the operator wants to communicate or sell. In their Day 3 Keynote at 21st Cloud Expo, Greg Chambers, Global Group Director, Digital Innovation, Coca-Cola, and Vidya Nagarajan, a Senior Product Manager at Google, discussed how from store operations and ...
    In his session at 21st Cloud Expo, Raju Shreewastava, founder of Big Data Trunk, provided a fun and simple way to introduce Machine Leaning to anyone and everyone. He solved a machine learning problem and demonstrated an easy way to be able to do machine learning without even coding. Raju Shreewastava is the founder of Big Data Trunk (www.BigDataTrunk.com), a Big Data Training and consulting firm with offices in the United States. He previously led the data warehouse/business intelligence and B...
    "IBM is really all in on blockchain. We take a look at sort of the history of blockchain ledger technologies. It started out with bitcoin, Ethereum, and IBM evaluated these particular blockchain technologies and found they were anonymous and permissionless and that many companies were looking for permissioned blockchain," stated René Bostic, Technical VP of the IBM Cloud Unit in North America, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Conventi...
    A strange thing is happening along the way to the Internet of Things, namely far too many devices to work with and manage. It has become clear that we'll need much higher efficiency user experiences that can allow us to more easily and scalably work with the thousands of devices that will soon be in each of our lives. Enter the conversational interface revolution, combining bots we can literally talk with, gesture to, and even direct with our thoughts, with embedded artificial intelligence, whic...
    When shopping for a new data processing platform for IoT solutions, many development teams want to be able to test-drive options before making a choice. Yet when evaluating an IoT solution, it’s simply not feasible to do so at scale with physical devices. Building a sensor simulator is the next best choice; however, generating a realistic simulation at very high TPS with ease of configurability is a formidable challenge. When dealing with multiple application or transport protocols, you would be...
    Smart cities have the potential to change our lives at so many levels for citizens: less pollution, reduced parking obstacles, better health, education and more energy savings. Real-time data streaming and the Internet of Things (IoT) possess the power to turn this vision into a reality. However, most organizations today are building their data infrastructure to focus solely on addressing immediate business needs vs. a platform capable of quickly adapting emerging technologies to address future ...
    We are given a desktop platform with Java 8 or Java 9 installed and seek to find a way to deploy high-performance Java applications that use Java 3D and/or Jogl without having to run an installer. We are subject to the constraint that the applications be signed and deployed so that they can be run in a trusted environment (i.e., outside of the sandbox). Further, we seek to do this in a way that does not depend on bundling a JRE with our applications, as this makes downloads and installations rat...
    Widespread fragmentation is stalling the growth of the IIoT and making it difficult for partners to work together. The number of software platforms, apps, hardware and connectivity standards is creating paralysis among businesses that are afraid of being locked into a solution. EdgeX Foundry is unifying the community around a common IoT edge framework and an ecosystem of interoperable components.
    DX World EXPO, LLC, a Lighthouse Point, Florida-based startup trade show producer and the creator of "DXWorldEXPO® - Digital Transformation Conference & Expo" has announced its executive management team. The team is headed by Levent Selamoglu, who has been named CEO. "Now is the time for a truly global DX event, to bring together the leading minds from the technology world in a conversation about Digital Transformation," he said in making the announcement.
    In this strange new world where more and more power is drawn from business technology, companies are effectively straddling two paths on the road to innovation and transformation into digital enterprises. The first path is the heritage trail – with “legacy” technology forming the background. Here, extant technologies are transformed by core IT teams to provide more API-driven approaches. Legacy systems can restrict companies that are transitioning into digital enterprises. To truly become a lead...
    Digital Transformation (DX) is not a "one-size-fits all" strategy. Each organization needs to develop its own unique, long-term DX plan. It must do so by realizing that we now live in a data-driven age, and that technologies such as Cloud Computing, Big Data, the IoT, Cognitive Computing, and Blockchain are only tools. In her general session at 21st Cloud Expo, Rebecca Wanta explained how the strategy must focus on DX and include a commitment from top management to create great IT jobs, monitor ...
    "Cloud Academy is an enterprise training platform for the cloud, specifically public clouds. We offer guided learning experiences on AWS, Azure, Google Cloud and all the surrounding methodologies and technologies that you need to know and your teams need to know in order to leverage the full benefits of the cloud," explained Alex Brower, VP of Marketing at Cloud Academy, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clar...
    The IoT Will Grow: In what might be the most obvious prediction of the decade, the IoT will continue to expand next year, with more and more devices coming online every single day. What isn’t so obvious about this prediction: where that growth will occur. The retail, healthcare, and industrial/supply chain industries will likely see the greatest growth. Forrester Research has predicted the IoT will become “the backbone” of customer value as it continues to grow. It is no surprise that retail is ...