SAP Library - Developing Applications Using Java

Developing Applications Using Java

Introduction to the SAP NetWeaver Developer Studio

Starting the Developer Studio

Setting Workspace Using the -data Parameter

Setting the Java VM Using the -vm Parameter

Changing the Default Workspace

Starting the Developer Studio Using a Batch File

Using Other Start Parameters

Update Manager

Viewing the Error Log File

Workbench Basics

Welcome Page

Available Perspectives

Basic Preferences

SAP Preferences

Working with the Developer Studio

SAP's Component Model

Creating and Modifying Projects

Referencing Libraries

Testing Java Applications

JLin

Creating and Editing Variants

Executing Tests

Results

J2EE Tests with JLin

Testing Web Dynpro Applications

Test Scripts and Test Results

Recording a Test Script in the Developer Studio

Replaying a Test Script in the Developer Studio

Comparing Scripts and Results

Development Technologies

Developing Java EE 5 Applications

Getting Started

Configuring the Application Server in the Developer Studio

Developing Your First Java EE 5 Application

Developing the EJB 3.0 Module

Developing the Web Module

Deploying and Running the Enterprise Application

Concepts

Java EE 5 Development Tools

Java EE Perspective

JPA Development Perspective

Deploy Perspective

Java Enterprise Edition 5 Overview

Java Persistent Entities

Web Services

JavaServer Faces

Application Server's Robustness and High Availability

Tasks

Developing Persistence

Overview of the Java Persistence Infrastructure

Using JPA in the Persistence Layer

Creating Connections to the Java Dictionary

Creating Database Connections

Creating JPA Projects in the Developer Studio

Creating Entities and Generating Database Tables

Generating Primary Keys

Creating Database Tables and Generating Entities

Working with the Entity Manager

Obtaining an Entity Manager Instance

Managing Entity Instances

Creating and Executing Queries

Configuring the Persistence Unit in the persistence.xml

Running JPA Applications on the System DataSource

Versioning with read_uncommitted Isolation Level

Developing Persistence Using Open SQL/JDBC

Getting a Connection to the Database

Inserting Data Into a Table

Using Queries

Semantics of the Data Types DATE, TIME, and TIMESTAMP

Transactions in Open SQL/JDBC

Native SQL Access

Error Handling

Using Open SQL for Java Features

Table Buffer

Buffer Granularity

Statements Using the Buffer

Statements Bypassing the Buffer

Modifications and Actions on the Remote Buffers

Buffering Hints

Open SQL Monitors

Managing the SQL Trace

Evaluating SQL Traces

Connection Monitor

Catalog Buffer Monitor

Table Buffer Monitor

Sync Log Monitor

Table Statistics Monitor

Open SQL Statistics

Native DB Monitors

Open SQL Data Browser

Reading and Writing LOBs En Bloc

Handling Transactions and Resources in Applications

Introduction to Transactions in AS Java

JTA Implementation

JTS Implementation

JTA and Local Transactions

Using Container-Managed JTA Transactions

Using Component-Managed JTA Transactions

Using Local Transactions

Two-Phase Commit

Resource Handling Mechanism

Connection Handling in JTA and Local Transactions

Sharing Connections

Database Connection Management

Developing Business Logic with EJB 3.0

EJB Overview

Creating EJB 3.0 Projects in the Developer Studio

Creating Session Beans in the Developer Studio

Setting a Session Timeout

Creating Message-Driven Beans in the Developer Studio

Setting the MDB Properties in the ejb-j2ee-engine.xml

Using Dependency Injection

Specifying Transaction Attributes

Specifying Security

Using Interceptors and Life Cycle Callbacks

Using Java Persistence API (JPA)

Using Enterprise JavaBeans as Web Service Endpoints

Editing the ejb-j2ee-engine.xml

Accessing Enterprise JavaBeans from Remote Clients

Using Timers

Developing User Interfaces

Creating Dynamic Web Projects

Using Annotations in Web Applications

Annotations in Web Applications

Injecting EJB Resources into Web Applications

Injecting Resources into Web Applications

Accessing Persistence in Web Applications

Configuring Methods Using Annotations in Web Applications

Configuring Security Roles Using Annotations in Web Applications

Developing JavaServer Faces (JSF) Web Applications

Creating the JSF UI Components

Creating JSF JSP Files

Standard JSF Tags

Dynamic Data Tables

Command Buttons

Validating User Input

Managed Beans

faces-config.xml

Developing Servlets

Creating Servlets in the Developer Studio

Initializing Servlets

Servicing Client Requests

Retrieving Client Input

Retrieving Multipart Request Messages

Request Attributes When Using Application Zones

Obtaining the Remote Host Address

Composing HTTP Responses

HTTP Response over Persistent Connections

IOException in Cases When Client Closes Connection

Threadsafe Servlets

Handling Cookies in Servlets

Setting Cookies in HTTP Servlets

Retrieving Cookies from the HTTP Request

AS Java Cookies

Servlet-defined Cookies

HTTP Sessions

Lifetime of a Session

Session Tracking with Servlets

Accessing and Manipulating the Session Object

Terminating a Session

URL Rewriting as an Alternative to Cookies

HTTP Sessions and Failover of Web Applications

Dispatching Requests to Web Application Resources

Including Requests

Forwarding Requests

Destroying Servlet Instances

Developing Event Listeners

Developing JSP Pages

Creating JSP Files in the Developer Studio

JSP Life Cycle

Syntax Elements Outline

Using the page Directive

Implicit Objects

Standard Actions

Including and Forwarding Requests in a JSP

JSTL

Developing Custom Tags

Developing Classic Tag Handlers

Developing Simple Tag Handlers

Developing TLD Files

Describing Tag Handlers in TLD Files

Developing Tag Files

Describing Tag Files in TLD Files

Unified Expression Language

EL Expressions in Tag Attribute Values

Deferred Expressions Evaluation

Using EL Implicit Objects

Developing EL Functions

Developing Portlets

Portlet Life Cycle

Implementing the Portlet Interface

Extending the GenericPortlet

Initializing Portlets

Servicing Action Requests

Servicing Render Requests

Portlet Preferences

Portlet Sessions

Dispatching Requests to Servlets and JSPs

User Information

Packaging and Deployment Descriptor

Portlet Tag Library

Creating Listeners and Filters

Editing the web-j2ee-engine.xml

Configuring Resource References Using the web-j2ee-engine.xml

Example: Describing Data Sources in the web-j2ee-engine.xml

Example: Describing JMS Connection Factories in the web-j2ee-eng

Creating and Configuring Web Services and Web Service Clients

Providing Web Services

Providing Web Services Inside Out

Creating an Inside-Out Web Service from an Enterprise Java Bean

Creating an Inside-Out Web Service from a Servlet-Based Endpoint

Service Endpoint Interface

Providing Web Services Outside In

Creating Outside-In Web Services

Importing WSDL Documents in the SAP NetWeaver Developer Studio

Browsing Enterprise Services from the SAP NetWeaver Developer St

Global Customizations

Providing a TU&C/C Web Service

Viewing Web Service Artifacts

Restrictions to Web Service Implementation Beans

Consuming Web Services

Creating Web Service Proxies

Creating Web Service Client Applications

Consuming TU&C/C Web Services

Extended Proxy Capabilities

Creating and Configuring Web Service Providers and Consumers for

Creating and Configuring Synchronous Web Service Providers for B

Creating and Configuring Asynchronous Web Service Providers for

Creating and Configuring Synchronous Web Service Consumers for B

Creating and Configuring Asynchronous Web Service Consumers for

Configuring Web Services at Design Time

Setting an Authentication Level

Setting the Transport Guarantee Level

Configuring a One Way Message Exchange Pattern

Configuring Web Services Reliable Messaging

Configuring Stateful Communication

Configuring Web Services and Web Service Clients in the SAP NetW

Concepts

Configuration of Individual Web Services and Web Service Clients

Configuration of Groups of Web Services

Configuration of Several Web Service Clients

Service Metering

Configuring Web Services

Configuring Individual Web Services

Configuring Groups of Web Services

Preparing the Configuration Settings in Profiles

Grouping and Configuring Web Services in Configuration Scenarios

Editing Configuration Scenarios

Managing WSDL Documents

Accessing Information Provided via WSIL

Configuring Web Service Clients

Configuring Individual Web Service Clients

Creating Web Service Physical Destinations

Testing Web Services in the Web Services Navigator

Finding Web Services

Testing a Web Service Operation

Testing Web Services with Pre-Defined Input Data

Viewing Web Services Logs and Traces

Configuring Proxy Settings

Publishing Web Services to the Services Registry

Connecting the SAP NetWeaver Developer Studio to the Services Re

Adding Classifications to Web Services

Publishing Web Services from the SAP NetWeaver Administrator

UDDI Registry

Creating tModels and Business Entities

Setting UDDI Keys

Adding General Details

Adding Specific Details to Business Entities

Creating Business Services

Adding Binding Templates to Business Services

Searching in the UDDI Registry

Customizing the Search Results

Supported Specifications

Tutorials

Configuring the SAP NetWeaver Developer Studio

Developing a HelloWorld Web Service

Creating the HelloWorld Web Service

Creating an Enterprise Java Bean Project for the HelloWorld Web

Creating the Enterprise Java Bean

Exposing the Enterprise Java Bean as a Web Service

Deploying the HelloWorld Web Service

Testing the HelloWorld Web Service

Creating the HelloWorld Web Service Client

Creating a Dynamic Web Project for the Web Service Client

Importing the WSDL Document

Generating the Web Service Proxy

Creating the Web Service Client Application

Deploying the HelloWorld Web Service Client

Exposing and Configuring the Converter Application as a Web Serv

Exposing the Converter Application as a Web Service

Importing the Converter Application in the SAP NetWeaver Develop

Exposing the Implementation EJB as a Web Service

Setting an Authentication Level to the Web Service

Deploying the Converter Web Service

Configuring the Web Service in the SAP NetWeaver Administrator

Testing the Converter Web Service

Creating the Converter Web Service Client

Creating a Dynamic Web Project for the Converter Web Service Cli

Importing the Converter WSDL Document

Generating the Converter Web Service Proxy

Creating the Converter Web Service Client Application

Deploying the Converter Web Service Client

Configuring the Web Service Client in the SAP NetWeaver Administ

Setting Severity to Web Services and Web Service Clients

Starting the Converter Web Service Client Application

Viewing Converter Web Service and Web Service Client Logs and Tr

Using Java Message Service

JMS Overview

Creating and Configuring JMS Virtual Providers

Creating and Configuring JMS Resources and Resource References

Property Reference

Accessing JMS Resources

Using a Third-Party JMS Provider

Using JMS Store and Forward

Creating Message Producers and Consumers

Using Queue Browsers

Using Durable Subscriptions

Using Message Selectors

Message Selector Syntax

Consuming Messages from Message-Driven Beans

Processing Messages

Handling Dead Messages

Using Transactions

Handling Exceptions

Example

Developing JCA Resource Adapters

Creating Connector Projects in the Developer Studio

Implementing 1.5 Resource Adapter

What's New in JCA 1.5

The Resource Adapter JavaBean

Outbound Communication

Inbound Communication

Message Endpoint Activation

Message Inflow Scenario

Transaction Inflow Support Implementation

Implementing the Work Management Contract

Implementing 1.0 Resource Adapter

Implementing Connection Management

Implementing Transaction Support

Implementing Interaction Functions

Assembling and Configuring the Resource Adapter

Resource Adapter Archive (RAR)

ManagedConnectionFactory Configuration

Resource Adapter Transaction Support

Connection Pooling

Resource Adapter Classloading

Using Resource Adapter to Obtain a Connection

Driving an Interaction with the EIS

Developing Application Clients

Working with Libraries

Creating Standard Libraries

Creating Bundled Libraries

Migrating Old Library Projects

Using Heavy Application Libraries

Heavy Loaders

Assembling Components into Enterprise Applications

Creating Enterprise Application Projects

Adding Modules to the Enterprise Application

Creating Bundled Libraries

Adding the application.xml to Enterprise Application Projects

Editing the application-j2ee-engine.xml

Deploying Applications

Deploying and Undeploying with SAP NetWeaver Developer Studio

Building, Publishing and Removing Published Java EE Applications

Deploying Archives

Working with Deploy Templates

Managing Deployed Archives

Undeploying Archives

Managing Substitution Variables

Viewing Deployment Related Logs

Filtering and Sorting Archives

Deploying Applications with Third-Party Deployment Tools

Using Ant Scripts to Work with SDAs

Using Shell Scripts to Work with SDAs

Managing the Application Environment

Creating Your Own Application Tables in the Database

demotables.sql

Working with Data Sources

Deploying Data Sources

Data Source Example

Deploying Data Source Aliases

Deploying JDBC Drivers

Creating J2EE 1.4 Applications in SAP NetWeaver Developer Studio

Creating J2EE 1.4-Compliant Web Components

Creating EJB 2.1 Components

Assembling J2EE 1.4-Compliant Enterprise Applications

Debugging Java Applications

Starting Remote Debugging

Stopping Remote Debugging

Using AS Java APIs

Using JavaMail

Obtaining a Session Object

Creating E-Mail Messages

Sending E-Mail Messages

Receiving E-Mail Messages

Creating Secure Connections Using JavaMail

HTTP Client

HTTP Client Properties

Simple Get Request to a Specified Host and Port Example

Get Request Using Proxy Example

Posting File Using Chunked Encoding Example

Get Request Using Basic Authentication Example

Managing System and Application Configurations

Configuration Manager

Monitoring Configurations

Java Configuration Browser

Adding Configuration Capabilities to an Application

Connecting As an AS Java Application

Deploying Properties Within an Application

Accessing Application Properties

Registering a Property Change Listener

Modifying Application Properties

Accessing the System Profile

Naming and Directory Services (JNDI)

JNDI Registry Service

Creating an Initial Context

Binding Objects

Looking up Objects

Browsing the Naming Tree

JNDI Browser

NAMING Shell Commands

Using JNDI Registry Service to Locate Resources

RMI-P4

The Distributed Object Model

Characteristics of a Remote Object

RMI-P4 System Overview

Remote Objects Communication in RMI-P4

Garbage Collection of Remote Objects

Load Balancing of Client RMI-P4 Requests

Failover for Clustered RMI-P4 Remote Objects

Network Configuration for RMI-P4

Develop RMI-P4 Applications

Defining a Remote Interface

Implementing the Remote Interface

Binding the Implementation to the Naming System

Generating Stubs and Skeletons

Implementing a Client

Accessing Enterprise JavaBeans from Remote Clients

Using P4 Protocol Over a Secure Connection

Additional P4 Protocol Connection Configuration

RMI-P4 Specific InitialContext Properties

Reference

Deployment Descriptors

appclient-j2ee-engine.xsd

application-j2ee-engine.xsd

connector-j2ee-engine.xsd

ejb-j2ee-engine.xsd

ejb-j2ee-engine_3_0.xsd

data-source-aliases.dtd

Tutorials

Project Management and Employee Services Application

Running the Application

Setting Up Application Users

Running the Predeployed Application

Deploying and Running the Application from NWDS

Application Data Model

Rebuilding the Project Management and Employee Services Applicat

Developing the Persistence Entities

Creating the EDMProjectEJBDemo

Generating the Project Entities

Implementing the Employee Entity

Configuring the Persistence Unit

Developing the Session Beans

Creating the ProjectManagementService Session Bean

Implementing the ProjectManagementService Session Bean

Developing the Message Driven Beans

Creating the ProjectChangeReceiver Bean

Defining the JMS Destination for the Bean

Implementing the ProjectChangeReceiver Bean

Reference

CeraDepartment Source Code

CeraEmployee Source Code

CeraNavigation Source Code

CeraProject Source Code

CeraPrjHistory Source Code

CeraSkill Source Code

CeraUsergroup Source Code

ApplicationResetReceiver Source Code

DataResetService Source Code

DataResetServiceLocal Source Code

EmployeeManagementService Source Code

EmployeeManagementServiceLocal Source Code

ProjectChangeReceiver Source Code

ProjectChangeSender Source Code

ProjectChangeSenderLocal Source Code

ProjectManagementService Source Code

ProjectManagementServiceLocal Source Code

Application Users and User Groups

Developing a Message-Driven Bean Application

Creating an EJB 3.0 Project and an EAR Project

Developing the Message-Driven Bean

Configuring the JMS Resources

Deploying the EAR

Sender JMS Client Example

Running the Example

Developing an Application Client

Creating and Implementing an EJB 3.0 Project

Creating and Implementing the Application Client

Deploying the Application

Running the Application Client

Java Persistence Reference

Overview of the JDBC API

JDBC Java Packages

java.sql

javax.sql

JDBC Java Classes and Interfaces

java.sql.Blob

java.sql.Clob

java.sql.Connection

java.sql.DatabaseMetaData

java.sql.Driver

java.sql.PreparedStatement

java.sql.ResultSet

java.sql.ResultSetMetaData

java.sql.Statement

Open SQL Reference

Open SQL Database Dependencies

Delimited Identifiers

SELECT FOR UPDATE Statement

Value expressions

Column References

Set Functions

Arithmetic Expressions

Dynamic Parameter Specification

Search Condition

Comparison predicate

Scalar Subqueries

Quantified comparison predicate

Data Type Conversion Tables

Mapping JDBC Types to Java Types

Type Conversions Supported by ResultSet Getter Methods

Type Conversions Supported by PreparedStatement Setter Methods

Open SQL Type Propagation

Providing Java Dictionary Tables and Data Types

Modifying Dictionary Preferences

Editing Table Definitions

Creating Views

Integrating Security Functions

Concepts

Developing Authentication Enhancements on the AS Java

Overview of the Login Process in JAAS

Integration of AS Java and UME Authentication

Using Login Modules to Protect Web Applications

Configuring Authentication

Using the HTTP Callback Classes

SAP Specific HTTP Callbacks

Changing the User Password

Single Sign-on for Web Applications

Security Sessions

Security Aspects for Web Services

Remote Authentication

Propagating Security Principals between Application Containers

Tasks

Developing a Custom Logon Screen

Create and Configure a Login Module

Creating and Implementing the Login Module

Creating a New Java Project

Setting Required Classpaths to Compile the Java Project

Implementing the Login Module Source Code

Exporting the Login Module Class in a JAR File

Creating and Implementing the Configuration File

Preparing the Login Module for Deployment

Creating a New Enterprise Application

Exporting a Deployable EAR File

Adding the JAR File and the Configuration File to the EAR File

Deploying the EAR to the AS Java

Configuring the Login Module on the AS Java

Example Login Module

Using APIs

User Management Engine

User Authentication and Single Sign-On

Searching for Users, Roles and Groups

Access Control List (ACL)

Digital Signatures and Document Encryption API

Interfaces and Classes for Using Digital Signatures and Encrypti

Examples for Using Digital Signatures

Secure Connection Factory API for HTTPS Clients

Interfaces and Classes for Using the Secure Connection Factory

Examples for Using the Secure Connection Factory

Destination Service API

Interfaces and Classes for Using the Destination Service API

Examples for Using the Destination Service API

Virus Scan Provider API

Interfaces and Classes of the Virus Scan Provider API

Example Program for the Virus Scan Provider

Using Common Server Infrastructure APIs

SAP NetWeaver Scheduler for Java

Architecture

Scheduler Job Definition, Job, and Task

Developing and Scheduling Jobs

Job Definition

JobBean Class

Deployment Descriptors

Job Scheduling Through the Scheduler API

Getting a JNDI Reference to the Scheduler API

Scheduling Jobs with Recurrent Start Conditions

Scheduling Jobs with Cron Start Conditions

Example: CronEntry

Excluding Scheduled Job Executions from a Scheduler Task

Reference

Scheduler Job Start Conditions

Scheduler Job Statuses

Job-definition.dtd

Job Parameter

Example: Job Parameters

Jobs Behavior in Irregular Circumstances

Creating and Scheduling Your First Job

Hello Job

Creating the Hello Job Definition

Creating an EJB Project

Creating a Message-Driven Bean

Setting the Build Path

Developing the JobBean Class of the HelloJob

Extending the JobBean Class with Job Parameters

Editing the ejb-j2ee-engine.xml

Creating and Editing the job-definition.xml

Editing the application-j2ee-engine.xml

Deploying the HelloJob

Scheduling the HelloJob

Creating a Scheduler Task for the HelloJob

Scheduling Jobs Using the SAP NetWeaver Scheduler for Java

Working with Jobs

Working with Tasks

Creating a Scheduler Task

Setting Recurring Start Conditions

Setting Cron Start Conditions

Setting Simple Start Conditions

Viewing Job Definitions

Developing Logging-Enabled Applications

Logging Quick Guide

How to Write Log and Trace Messages

Logging

Addressees of Log Messages

How to Use Categories

Types and Content of Log Messages

Severities for Log Messages

Tracing

Addressees of Trace Messages

How to Use Locations

Types and Contents of Trace Messages

Severities for Trace Messages

Coding Recommendations

Enabling Logging for Applications

Identify the Output Source: Location or Category

Enable Output Messages

Message Output with Severity

Program Flow for a Location

The Master Gate

Typical Practice for a Better Style

Hierarchical Destination Inheritance

Relations Between Category and Location

Multi-Threading

Configuration Tool

Calling the Configuration Tool

Syntax and Semantics of the Properties File

Support of Periodic Reloading

Summary Highlights

Tips and Tricks

Administrative Issues

Appendix A: Severity Levels

Appendix B: Classes Hierarchy

Appendix C: Default Behavior of Certain Objects

Enabling Applications with Monitoring

Enabling Standard Application Resources Administration

JMX Service Interface

Architecture

Writing MBeans

Connecting to an MBeanServer

MBean Registration

Access to an MBean

Query MBeans

Receiving Notifications

JMX Client Structure

Administration Adapter Service

Java Application Monitoring

Monitoring Concept

Monitors Inside the Monitoring Tree

Monitoring Resources with the Monitoring Framework

The monitor-configuration.xml

Template Monitors

Using Template Monitors

Instrumenting an Application to Provide Monitoring Data

Acquiring a Reference to the MBean Server

Building ObjectName(s) for the Resource MBean(s)

Registering the MBean

Sending Monitoring Data Actively Via JMX Notifications

Instrumenting the Application

Example of Application Instrumented with Monitoring

Designating the Variables You Want to Monitor

Developing the Resource MBean and the monitor-configuration.xml

Creating the Bank Name Text Monitor

Creating the Bank Information Configuration Monitor

Creating the Bank Rank State Monitor

Creating the Counter Desks Table Monitor

Creating the Software Version Version Monitor

Creating the Open for Clients Availability Monitor

Creating the Served Clients Long Monitor

Creating the All Clients Integer Monitor

Creating the Transaction Frequency Frequency Monitor

Creating the Transactions Over 10,000 EUR Quality-Rate Monitor

Creating the Transaction Duration Duration Monitor

Dynamically Installed Monitors

Installing the Template

Installing the Template-Based Monitors

Registering the MBean

Assigning Administrator Permissions

A Programmatic Interface that Creates and Installs Monitors Dyna

Configuration Groups

Simple Configuration Group

Configuration Configuration Group

Text Configuration Group

Version Configuration Group

Table Configuration Group

Duration Configuration Group

Frequency Configuration Group

Integer Configuration Group

Long Configuration Group

Quality-Rate Configuration Group

State Configuration Group

Summary Nodes, Object Nodes and Monitors

Installation of Summary and Object Nodes

Installation of Monitors

Installation of Table and State Monitors

Uninstallation of Summary Nodes, Object Nodes, and Monitors

Customization of Configuration Groups Using Third-Party Tools

Retrieving Monitoring Data from an External Client via JMX

Performance Monitors and Their Methods

Non-Performance Monitors and Their Methods

Using the Generic Configuration Reporter

Types of Monitors and Their Usage

Configuration Monitor

Administering AS Java from the Developer Studio

Starting and Stopping SAP Systems

Viewing the Communication Ports

Monitoring the Application Server with the SAP Management Consol

Starting and Stopping Components

Enabling and Disabling the Debug Mode

Viewing Log and Trace Files

Changing Log Configuration

Recording Issues with the Support Session

Creating and Examining Snapshots

Reference

Layout of the SAP Management Console

Context Menus and Settings of the SAP Management Console

Administration Using Telnet