Home > Articles > Programming > Java

Like this article? We recommend Running JBoss 5

Running JBoss 5

As in my previous article on JBoss 5, you need to download and install three items of software to run the supplied code:

  • Apache Ant
  • JDK v1.5
  • JBoss 5

Listing 1 illustrates the version of Ant I used for this article (make sure that Ant is in your system path), followed by the version of JDK I used.

Listing 1 Apache Ant and JDK versions used.

C:\java\jboss-5.0.0.GA\bin>ant -version
Apache Ant version 1.7.1 compiled on June 27 2008

C:\java\jboss-5.0.0.GA\bin>java -version
java version "1.5.0_17"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_17-b04)
Java HotSpot(TM) Client VM (build 1.5.0_17-b04, mixed mode, sharing)

To run the example code, you need two DOS consoles—one to run JBoss and the other to run the client code. A handy way to do this is as follows:

  1. Open one DOS console.
  2. Set the two required environment strings—JAVA_HOME and JBOSS_HOME.
  3. Run the command start.

The start command clones the first DOS console and creates a copy with all the same environment settings. Of course, you can set the environment variables through the control panel, but I generally prefer to set them up as I go. This has the merit of avoiding clutter.

Once you've run the above steps, you can then run JBoss 5 by changing to the bin folder and executing the following command:

C:\java\jboss-5.0.0.GA\bin>run

Notice that I use a directory path with no spaces. Once you run this command, you should see a ton of console messages. If you're running Windows Firewall, you may see a message like the one in Figure 1.

Figure 1 Windows Firewall doing its job.

Just click Unblock to allow the JDK binary to run. If all is well with your setup, you should then see a successful message at the end of the console, as shown in Listing 2.

Listing 2 Successful JBoss 5 startup.

12:02:58,609 INFO  [Http11Protocol] Starting Coyote HTTP/1.1 on http-127.0.0.1-8080
12:02:58,750 INFO  [AjpProtocol] Starting Coyote AJP/1.3 on ajp-127.0.0.1-8009
12:02:58,765 INFO  [ServerImpl] JBoss (Microcontainer) [5.0.0.GA (build: SVNTag=
JBoss_5_0_0_GA date=200812041714)] Started in 3m:2s:484ms

If you've managed to get this far without incident, you're ready to run the client. As in the previous article, this is a three-step process:

  1. Build.
  2. Deploy.
  3. Execute.

Let's see how to do this.

Code Build

The code is built simply by opening a DOS console in the folder containing the Ant script: build.xml. The DOS console is the second console I mentioned earlier. In order to run correctly, you need the following:

  • Ant in the build path
  • JAVA_HOME defined
  • JBOSS_HOME defined

To check whether you're ready to build the code, run the following handy command:

ant –p

If all is well, you should see something like Listing 3.

Listing 3 Ant build targets.

Buildfile: build.xml

Main targets:

Other targets:

 clean
 clean.db
 compile
 ejbjar
 prepare
 run.client
Default target: ejbjar

Listing 3 shows all the targets contained in the build file.

The default Ant target is executed simply by running the ant command with no parameters. This command also deploys the code into JBoss 5. Let's try these two important steps now.

Code Deployment

The code is built and deployed using the following simple command:

ant

If this command is successful, you should see a message to that effect in the DOS console. You should also see a successful deployment in the JBoss 5 DOS console. Look for messages such as the ones in Listing 4.

Listing 4 Successful deployment in JBoss 5.

12:48:30,953 INFO  [SchemaExport] Running hbm2ddl schema export
12:48:30,968 INFO  [SchemaExport] exporting generated schema to database
12:48:30,968 INFO  [SchemaExport] schema export complete
12:48:30,968 INFO  [NamingHelper] JNDI InitialContext properties:{java.naming.factory.initial=
   org.jnp.interfaces.NamingContextFactory, java.naming.factory.url.pkgs=org.jboss.naming:org.jnp.interfaces}
12:48:31,234 INFO  [SessionSpecContainer] Starting jboss.j2ee:jar=cardsrus.jar,name=CardShopBean,service=EJB3
12:48:31,234 INFO  [EJBContainer] STARTED EJB: com.cardsrus.cardshop.CardShopBean ejbName: CardShopBean
12:48:31,265 INFO  [JndiSessionRegistrarBase] Binding the following Entries in Global JNDI:

        CardShopBean/remote - EJB3.x Default Remote Business Interface
        CardShopBean/remote-com.cardsrus.cardshop.CardShopRemote - EJB3.x Remote Business Interface

The really important items in Listing 4 are at the end, related to the deployment of the EJB and the registration of the code in JNDI. Notice also the message STARTED EJB in Listing 4. This means that our EJB is deployed on JBoss and ready for business. Think of this as a little server application waiting for service requests.

Now we can run the client code. For simplicity, the deployed code already includes the interceptor logic. Before I describe that, let's just run the client code to make sure that everything is working correctly.

Running the Client Code

The client code is executed using another Ant target:

ant run.client

Listing 5 demonstrates a successful run.

Listing 5 A successful run of the client code.

ant run.client
Buildfile: build.xml

prepare:

compile:

ejbjar:

run.client:
     [java] Greeting card name: Early Easter Greetings from Terry Dactyll
     [java] Greeting card colour: 1

BUILD SUCCESSFUL
Total time: 9 seconds

In Listing 5, we see that a greeting card has been received! That's the client end, but what happens on the server side?

Server Side

If the interceptor code runs successfully, you should see something similar to Listing 6.

Listing 6 Successful interception.

com.cardsrus.cardshop.CardShopBean.flushGreetingCard()
13:57:38,375 INFO  [STDOUT] Now at the beginning of the interceptor method public 
void com.cardsrus.cardshop.CardShopBean.createGreetingCard(com.cardsrus.domain
  .GreetingCard) startTimeSnapshot 1236693458375
13:57:38,390 INFO  [STDOUT] Now at the end of the interceptor method public 
  void com.cardsrus.cardshop.CardShopBean.createGreetingCard(com.cardsrus.domain.GreetingCard) 
  endTimeSnapshot 1236693458390
13:57:38,390 INFO  [STDOUT] Method public void com.cardsrus.cardshop.CardShopBean.
  createGreetingCard(com.cardsrus.domain.GreetingCard) time taken: 15 milliseconds

What's going on in Listing 6? It's the interceptor code in action, and it's finally time to look at it.

Interceptor Logic

The whole idea of interceptor code is the ability to insert new code inside the execution of existing code. This sounds complicated, but it isn't. Listing 7 shows the code location into which we want to insert some new code.

Listing 7 Code we want to intercept.

public void createGreetingCard(GreetingCard greetingCard)
{
    manager.persist(greetingCard);
}

I basically want this code to change to something like Listing 8.

Listing 8 Intercepted pseudo-code.

public void createGreetingCard(GreetingCard greetingCard)
{
  // Some new code here
       manager.persist(greetingCard);
  // And more new code here
}

The way we engineer this is by creating an interceptor class as in Listing 9.

Listing 9 The interceptor class.

public class ExecutionProfiler
{
   @AroundInvoke
   public Object profile(InvocationContext invocation) throws Exception
   {
      long startTimeSnapshot = System.currentTimeMillis();

      System.out.println("Now at the beginning of the interceptor method " +
      invocation.getMethod() + " startTimeSnapshot " + startTimeSnapshot);

      try
      {
         return invocation.proceed();
      }
      finally
      {
         long endTimeSnapshot = System.currentTimeMillis();
         long executionTime = System.currentTimeMillis() - startTimeSnapshot;
         System.out.println("Now at the end of the interceptor method " +
         invocation.getMethod() + " endTimeSnapshot "  + endTimeSnapshot);
         System.out.println("Method " + invocation.getMethod()
                            + " time taken: " + executionTime + " milliseconds");
      }
   }
}

The best way to think about Listing 9 is to look at the comments in Listing 8. Notice the try statement in Listing 9? This code roughly equates to the Listing 8 code manager.persist(greetingCard). The rest of the code in Listing 9 occurs around the execution of manager.persist(greetingCard).

Look back at the console output in Listing 6. You can match the Listing 6 console output to the Listing 9 calls to System.out.println. Why might this be useful? It's useful because we can insert any code we like in the ExecutionProfiler class. An example of such code might be security authorization. The key point is that such code doesn't appear anywhere else outside the ExecutionProfiler class. In other words, we keep the code in the business logic and entity classes (and the other parts of the source code) completely clean. This is the power of interceptor code.

Now, how do we remove our code from JBoss?

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020