Welcome!

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

Related Topics: Weblogic

Weblogic: Article

conf2admin

Automate script creation for your WebLogic Server domain configuration

Enterprise software applications are complex, but almost certainly more complex is the underlying software that provides services and resources to these applications. There are different types of software that fall into the latter category, one of those being a Java application server, which of course for this article is the BEA WebLogic Application Server.

In this article I'll examine the use of scripting languages with WebLogic Server and use code generation to facilitate the creation of scripts.

Benefits of Scripting Languages
To be more productive, system administrators create scripts that enable them to rapidly execute repetitive tasks. These scripts can execute tasks for configuration and control. In the case of WebLogic Server, these scripts are used to do things like start and stop servers, or configure some aspect of a server.

BEA WebLogic Server has different types of scripting languages available today, two of which are shipped with WebLogic Server and one of which is an open-source program called WLShell. The two languages that ship with WebLogic Server are weblogic.Admin and WLAnt. The weblogic.Admin utility interprets commands that enable you to accomplish a variety of administrative tasks. The syntax of the language weblogic.Admin understands is proprietary in nature. The WLAnt language is a set of Ant tasks that accomplish tasks similar to those of weblogic.Admin. The WLShell language, while accomplishing similar tasks, is another syntax to learn, but adds an interactive shell for executing commands and interacting with the domain.

As with any programming language, there is a learning curve before you become comfortable with it. This learning process encompasses the language fundamentals and how to effectively use the language to your best advantage. After you learn the language fundamentals, you must then learn how to apply this to the WebLogic Server domain. Let's briefly look at how to apply each of these scripting languages to a WebLogic Server domain entity, the server.

WebLogic Server Domain
The BEA WebLogic Server has many components that provide runtime services and resources to applications running in it. Some of the components you'll find in a WebLogic Server domain are servers, clusters, JDBC Connection Pools, JMS servers, and JMS Queues to name a few. Each of these scripting languages is applied differently to these objects. For example, writing a script to create a WebLogic Server, along with some properties, for each of the languages would look like Listing 1. (Note: Some statements have been omitted for brevity.)

As you can see, each language has a different syntax for doing the same task, but each conceptually works in the same way, and for different types of WebLogic Server entities. Writing and maintaining these scripts can in some cases be a time-consuming process, keeping in mind that you have to be familiar with the syntax. In some cases, you might use scripts to help in the creation of an entirely new domain. Writing such a large script would be a time-consuming and potentially error-prone process.

We can, however, enhance the process of script writing using code-generation, which enables you to:

  • Rapidly create reusable management code snippets
  • Reduce the learning curve of one of the languages
  • Reduce the learning curve of applying the language to the WebLogic Server domain
  • Provide the ability to generate scripts in the language of your choice

    Introducing conf2admin
    conf2admin is a utility that processes a config.xml and produces output in the form of a scripting language. The current implementation includes support for weblogic.Admin, but Ant and WLShell are planned. The primary features of conf2admin are:

  • Runs against offline configuration
  • Generates scripts in the scripting language of your choice
  • Generates an undo file
  • Generates a script for deploying applications in the domain
  • Excludes certain WebLogic Server entities from output

    The BEA WebLogic Server domain configuration is an XML format file that describes the configuration for servers, clusters, and applications to name a few. The conf2admin utility works by executing an XSLT transformation against the config.xml document, and has XSL templates that produce the commands necessary for creating and setting values on WebLogic Server domain entities.

    Figure 1 illustrates the general concept of conf2admin. Before we continue, let's take a brief look at the core technology behind conf2admin, the Extensible Stylesheet Language Transformations or XSLT.

     

    XSLT
    XSLT is an XML-based transformation language that works by matching templates against markup-like elements and attributes in an XML document. The templates in conf2admin match against elements in the BEA WebLogic Server domain configuration. The output from these templates is the script code that you will execute using weblogic.Admin or some other script interpreter. The following code snippet shows what a template looks like.

    <xsl:template match="//Server">

    <!—specify contents of template here ‡

    </xsl:template>

    XSLT is a good choice for working with an XML-based configuration. We can get document parsing for free from the XML parser, and a parser for the templates. Writing an XSLT template is pretty straightforward. I won't cover the XSLT specification in depth, but will focus on the sections of the stylesheet relevant to the code generation.

    Applying conf2admin to Medrec
    We'll take the conf2admin utility and run it against the WebLogic Server MedRec samples domain configuration. The MedRec sample ships with BEA WebLogic Server and includes a variety of WebLogic Server resources. Depending on which release of BEA WebLogic Server you have, your MedRec domain configuration might be slightly different. We'll run the utility and focus on the MedRecServer and JDBCConnectionPool resources that will be generated. Those resources are represented by entries in the domain configuration that look like Listing 2.

    When you run the conf2admin utility against the MedRec config.xml, the resulting file will be filled with many lines of generated code; the two snippets for our example deal with the server and the JDBCConnectionPool (see Listing 3)

    From the output you can see that a command for CREATE was generated that will create the server. There were also four SET commands created, each representing the set for an attribute on that Server. Listing 4 lists similar results for the JDBCConnectionPool.

    The conf2admin utility matches against elements in the configuration, in this case the server and JDBCConnectionPool elements, and instantiates the template for emitting CREATE commands. The stylesheet does not name the individual elements it looks for; it merely matches against whatever elements it finds. Next, within the template that emits the CREATE commands, conf2admin begins processing attributes and emitting commands to SET properties on the newly created server or JDBCConnectionPool entities. This flow of processing continues until the entire document has been processed.

    The conf2admin utility will also emit some comment blocks, which indicate the source location in the config.xml that the generated code came from. So in the example of the MedRecServer, the comment block looks like this:

    #================================================
    #==
    #== Creating MBean of type Server
    #==
    #== Origin: /[1]/Domain[1]/Server[1]
    #==
    #================================================

    The origin comment indicates the location in the document expressed as an XPath expression. The numbers in brackets are the indices of the element since in some cases there can be several of a particular type.

    Once the output is generated, you can use that file as input into the weblogic.Admin interpreter in batch mode. The documentation for conf2admin describes how to configure it to generate commands for stand-alone interpretation of script commands. The default is to generate commands to be used in batch mode of weblogic.Admin.

    Summary
    In this article I looked at the scripting languages that are available for BEA WebLogic Server and how you can use code generation to enable quick creation of management scripts. While seemingly powerful, there are some limitations to using XSLT to generate code. It does not include a friendly interface for looping to reprocess parts; instead, you must recursively call a template until you are finished processing. There is also no real concept of flow control within a template.

    Links
    The following links may provide you with more details about the technologies and concepts discussed here.

  • conf2admin on dev2dev: http://dev2dev.bea.com/resourcelibrary/utilitiestools/adminmgmt.jsp
  • WLShell: www.wlshell.com
  • WebLogic Admin: http://e-docs.bea.com/wls/docs81/admin_ref/cli.html
  • WebLogic Server Ant tasks: http://edocs.bea.com/wls/docs81/admin_ref/ant_tasks.html
  • XML 1.0 (Second Edition): www.w3.org/TR/REC-xml
  • XPath 1.0: www.w3.org/TR/xpath
  • XSLT 1.0: www.w3.org/TR/xslt
  • More Stories By Mike Jasnowski

    Mike Jasnowski is a senior software engineer on the BEA WebLogic Server Administration Console team. He has been involved in development for almost 20 years and in many industries. Mike is a contributing author to several books and author of JMX Programming (Wiley)

    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
    With tough new regulations coming to Europe on data privacy in May 2018, Calligo will explain why in reality the effect is global and transforms how you consider critical data. EU GDPR fundamentally rewrites the rules for cloud, Big Data and IoT. In his session at 21st Cloud Expo, Adam Ryan, Vice President and General Manager EMEA at Calligo, examined the regulations and provided insight on how it affects technology, challenges the established rules and will usher in new levels of diligence arou...
    SYS-CON Events announced today that Evatronix will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Evatronix SA offers comprehensive solutions in the design and implementation of electronic systems, in CAD / CAM deployment, and also is a designer and manufacturer of advanced 3D scanners for professional applications.
    SYS-CON Events announced today that Synametrics Technologies will exhibit at SYS-CON's 22nd International Cloud Expo®, which will take place on June 5-7, 2018, at the Javits Center in New York, NY. Synametrics Technologies is a privately held company based in Plainsboro, New Jersey that has been providing solutions for the developer community since 1997. Based on the success of its initial product offerings such as WinSQL, Xeams, SynaMan and Syncrify, Synametrics continues to create and hone inn...
    Cloud Expo | DXWorld Expo have announced the conference tracks for Cloud Expo 2018. Cloud Expo will be held June 5-7, 2018, at the Javits Center in New York City, and November 6-8, 2018, at the Santa Clara Convention Center, Santa Clara, CA. Digital Transformation (DX) is a major focus with the introduction of DX Expo within the program. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive ov...
    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...
    To get the most out of their data, successful companies are not focusing on queries and data lakes, they are actively integrating analytics into their operations with a data-first application development approach. Real-time adjustments to improve revenues, reduce costs, or mitigate risk rely on applications that minimize latency on a variety of data sources. In his session at @BigDataExpo, Jack Norris, Senior Vice President, Data and Applications at MapR Technologies, reviewed best practices to ...
    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 ...
    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...
    "Digital transformation - what we knew about it in the past has been redefined. Automation is going to play such a huge role in that because the culture, the technology, and the business operations are being shifted now," stated Brian Boeggeman, VP of Alliances & Partnerships at Ayehu, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
    "Evatronix provides design services to companies that need to integrate the IoT technology in their products but they don't necessarily have the expertise, knowledge and design team to do so," explained Adam Morawiec, VP of Business Development at Evatronix, in this SYS-CON.tv interview at @ThingsExpo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
    The 22nd International Cloud Expo | 1st DXWorld Expo has announced that its Call for Papers is open. Cloud Expo | DXWorld Expo, to be held June 5-7, 2018, at the Javits Center in New York, NY, brings together Cloud Computing, Digital Transformation, Big Data, Internet of Things, DevOps, Machine Learning and WebRTC to one location. With cloud computing driving a higher percentage of enterprise IT budgets every year, it becomes increasingly important to plant your flag in this fast-expanding busin...
    In his Opening Keynote at 21st Cloud Expo, John Considine, General Manager of IBM Cloud Infrastructure, led attendees through the exciting evolution of the cloud. He looked at this major disruption from the perspective of technology, business models, and what this means for enterprises of all sizes. John Considine is General Manager of Cloud Infrastructure Services at IBM. In that role he is responsible for leading IBM’s public cloud infrastructure including strategy, development, and offering m...
    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...
    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...
    Recently, REAN Cloud built a digital concierge for a North Carolina hospital that had observed that most patient call button questions were repetitive. In addition, the paper-based process used to measure patient health metrics was laborious, not in real-time and sometimes error-prone. In their session at 21st Cloud Expo, Sean Finnerty, Executive Director, Practice Lead, Health Care & Life Science at REAN Cloud, and Dr. S.P.T. Krishnan, Principal Architect at REAN Cloud, discussed how they built...
    22nd International Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, and co-located with the 1st DXWorld Expo will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud ...
    22nd International Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, and co-located with the 1st DXWorld Expo will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud ...
    DevOps at Cloud Expo – being held June 5-7, 2018, at the Javits Center in New York, NY – announces that its Call for Papers is open. Born out of proven success in agile development, cloud computing, and process automation, DevOps is a macro trend you cannot afford to miss. From showcase success stories from early adopters and web-scale businesses, DevOps is expanding to organizations of all sizes, including the world's largest enterprises – and delivering real results. Among the proven benefits,...
    @DevOpsSummit at Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, is co-located with 22nd Cloud Expo | 1st DXWorld Expo and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The widespread success of cloud computing is driving the DevOps revolution in enterprise IT. Now as never before, development teams must communicate and collaborate in a dynamic, 24/7/365 environment. There is no time to wait...
    SYS-CON Events announced today that T-Mobile exhibited at SYS-CON's 20th International Cloud Expo®, which will take place on June 6-8, 2017, at the Javits Center in New York City, NY. As America's Un-carrier, T-Mobile US, Inc., is redefining the way consumers and businesses buy wireless services through leading product and service innovation. The Company's advanced nationwide 4G LTE network delivers outstanding wireless experiences to 67.4 million customers who are unwilling to compromise on qua...