Sun Java System Reference Configuration Series: Portal Service on Application Server Cluster

Chapter 2 Reference Configuration Architecture

This chapter describes the design of the Portal Service on Application Server Cluster reference configuration, based on the functional and quality-of-service requirements that are specified in Business and Technical Requirements.

Read this chapter to understand the design rationale of the reference configuration before attempting to implement the deployment architecture in your own hardware environment.

The design of the reference configuration consists of a two-step process, first developing the logical architecture and then developing the deployment architecture, as described in the following sections:


Note –

This reference configuration architecture uses a web container provided by Sun JavaTM System Application Server. While the architecture would not change substantially if Sun Java System Web Server were used to provide the web container, the implementation procedures would be substantially different.


Logical Architecture of the Reference Configuration

A logical architecture shows the software components (and the interactions between them) that are needed to provide a specific set of services to end users.

An analysis of the reference configuration's functional requirements and quality-of-service requirements (which specify the required performance, availability, scalability, security, and serviceability) is the basis for determining the main Java ES software components that are needed to meet these requirements. In most cases, these components interact with or are dependent upon other, secondary software components. For information about Java ES components, the services they provide, and interdependencies between those components, see the Sun Java Enterprise System 5 Update 1 Technical Overview.

The following sections describe the Java ES components that are used in the portal service reference configuration, their roles within the reference configuration, and the interactions between them:

Logical Architecture Diagram

The various components that are needed to meet the reference configuration requirements depend on their functions as distributed infrastructure services or their roles within a tiered application framework. In other words, the various components represent two views or dimensions that define a logical architecture: the logical tier dimension and the distributed infrastructure services dimension. These dimensions are described in the Sun Java Enterprise System 5 Update 1 Technical Overview.

The positioning of reference configuration components in such a two-dimensional framework is shown in the following logical architecture diagram. Components are placed within a horizontal dimension that represents standard logical tiers and within a vertical dimension that represents infrastructure service dependency levels. The positioning of a component in this matrix helps describe the role that the component plays in the logical architecture.

For example, Access Manager is a component that is used by presentation and business service tier components to provide security and policy infrastructure services. However, Application Server is a component that is used by presentation and business service tier components to provide distributed runtime services.

Figure 2–1 Logical Architecture of the Reference Configuration

Graphic representation of the logical architecture described
in the text.

A description of the tiers shown in Figure 2–1 is provided in the following table.

Table 2–1 Logical Tiers in the Architecture Diagram

Tier 

Description 

Client 

In the Client tier are applications that are used by users to access portal services. In this reference configuration, the only client applications that are used are a browser and a stand-alone Java client.  

Access 

This tier enables remote users to securely access their organization's network and its services over the Internet. The Access tier acts as a communication relay between the Client tier and the Presentation tier, and includes the Portal Server Secure Remote Access components needed to securely access portal services from the Internet.

Presentation 

This tier provides aggregation and presentation capabilities that enable users to access relevant information and personalize their desktop to best meet their needs. In addition, this tier provides community, collaboration, content, and knowledge management capabilities. This tier is implemented using Portal Server software. 

Business Service 

This tier contains the back-end services that are aggregated and presented to users by services in the Presentation tier. Examples of applications that might reside in this tier include: email systems, calendar servers, and Enterprise Resource Planning (ERP) applications (SAP, PeopleSoft, Siebel, and so forth.). Also, this tier contains portlets and application components that are deployed in a web container or application server. 

Data 

This tier provides a permanent repository that business services can use to store persistent information. This tier includes Directory Server (used by Access Manager and Portal Server to store user profiles) and Java DB (used to store application data). High Availability Session Store (HADB), which is used to store portlet session state, is placed in the Presentation tier to indicate its functional relationship to Portal Server. 

Software Components in the Logical Architecture

While Figure 2–1 is indicative of the role of the different components within the reference configuration's logical architecture, the following table describes more precisely the purpose of each component.

Table 2–2 Software Components in the Logical Architecture

Component 

Component's Role in the Architecture 

Web Browser client 

While not formally a component of the reference configuration, the browser client is included in the architecture diagram to show how users will access portal services. There are two access scenarios: 

  • Access from a trusted network: browser clients (for example, an organization's employees) connect to portal services over the local network (or intranet) or from the Internet by using a virtual private network (VPN) or a similar solution.

  • Access from an unsecured network: Web browser clients (of a business-to-business or business-to-consumer portal) connect to portal services over the public Internet. This access scenario is supported by the Secure Remote Access (SRA) Gateway.

Remote client (optional) 

In addition to browsers, users can use applets that are included with Portal Server SRA software:  

  • Netlet. The Netlet applet runs on the browser and sets up an encrypted TCP/IP tunnel between the remote client and intranet applications in the Business Service tier. Netlet listens to and accepts connections on preconfigured ports, and routes both incoming and outgoing traffic between the client and the destination server. In this way, Netlet enables client applications to securely access intranet business service components.

  • Netfile. NetFile is a file manager application that allows remote access and operation of file systems.

  • Proxylet. Proxylet is a dynamic proxy server that runs on the browser and redirects a URL to the SRA Gateway. It does so by reading and modifying the proxy settings of the browser on the client so that the settings point to the local proxy server or Proxylet. Proxylet is used to reduce the number of ports that must be opened in a firewall through which the SRA Gateway(see next item) connects to Internet hosts. It is also used to minimize or eliminate the dependency on the Rewriter Proxy (see next item) and Rewriter rulesets.

Sun Java System Portal Server Secure Remote Access (Portal Server SRA) 

Portal Server SRA provides a gateway service that allows secure connections over the public Internet to applications and content on an internal intranet, but only to authorized users. In addition to the SRA Gateway, SRA includes the following two optional components, depending on your requirements: 

  • Netlet Proxy. The Netlet proxy is an stand-alone Java process that enhances the security between the SRA Gateway and the intranet by extending the secure tunnel from the client through the Gateway to the Netlet proxy that resides in the intranet. Netlet packets are decrypted by the proxy and then sent to their destinations. This mechanism helps to reduce the number of ports that must be opened in a firewall.

  • Rewriter Proxy. The Rewriter proxy is a stand-alone Java process that is installed on the intranet. The SRA Gateway forwards all requests to the Rewriter proxy, which fetches and returns the content of the request to the Gateway. This mechanism helps to reduce the number of ports that must be opened in a firewall.

Sun Java System Portal Server (Portal Server) 

Portal Server provides key portal services, such as content aggregation and personalization, to browser-based clients that are accessing business applications or services in the Business Service tier.  

Sun Java System Access Manager (Access Manager) 

Access Manager provides access management services such as authentication and role-based authorization for user access to applications and services. In cases where Access Manager is remote from a local component, Access Manager SDK provides an interface to the remote Access Manager services. 

Sun Java System Application Server (Application Server) 

Application Server provides the Java Platform, Enterprise Edition (Java EE) web container that is needed to support web components, such as Portal Server, Access Manager, portlet applications, and so forth. While a web container can also be provided by Sun Java System Web Server, the Portal Service on Application Server Cluster reference configuration uses Application Server. 

Applications 

Various kinds of applications provide the content for Portal Server channels that are accessed by end users. These applications can include email systems, calendar servers, ERP applications, custom or third-party portlet applications deployed on a web container, and so forth. 

Sun Java System Directory Server (Directory Server) 

Directory Server provides an LDAP repository for storing information about portal users, such as identity profiles, user credentials, access privileges, application resource information, and so forth. This information is used by Access Manager for authentication and authorization and by Portal Server to build users' portal desktops.  

Sun Java System Message Queue (Message Queue) 

Message Queue is a reliable asynchronous messaging service that is used by Access Manager to write user session state into a replicated session database and to retrieve such state information when necessary.  

High Availability Session Store (HADB) 

HADB provides a data store that makes application data, especially session state data, available even in the case of failure. 

Java DB 

Java DB is the default relational database used by Portal Server to support community features and selected portal applications. 

Interactions Between Reference Configuration Components

To design a logical architecture, you must understand the software dependencies and interactions between the various components that are listed in Table 2–2. These interactions can be somewhat complicated and difficult to illustrate in a single diagram such as Figure 2–1. The main interactions between components in the reference configuration are therefore described briefly in the table below, in the context of typical portal service operations.

Two access scenarios are incorporated into the following table:

Table 2–3 Interactions Between Reference Configuration Components

Step 

What Happens 

The user starts a browser and opens the portal service or SRA Gateway service URL, depending on the access scenario being used. 

If portal services are accessed directly, Portal Server returns the anonymous desktop, which includes the login channel. If portal services are accessed through the SRA Gateway, the Gateway redirects the user request to Access Manager. Access Manager returns the login page (by way of the Gateway). 

The user logs in by typing a user ID and password in the appropriate form and clicking Login. 

Access Manager interacts with Directory Server to retrieve the user's profile, which contains authentication, authorization, and application-specific information. 

Access Manager authenticates the user's ID and password against the LDAP directory information and creates a session object.  

When the user has been authenticated, Access Manager returns a session cookie to the user's browser and redirects the browser to Portal Server. 

 

Portal Server uses the session cookie to interact with Access Manager to access information in the user's profile (cached by Access Manager). Portal Server uses the information to build the user's personalized portal desktop. Portal Server returns the desktop to the user's browser (by way of the Gateway). 

The user reviews his or her portal desktop, and clicks a portal channel. 

Portal Server interacts with Access Manager to validate the status of the user session. Access Manager authorizes the channel content that is being requested by the user.  

When appropriate, Portal Server creates a portlet session and returns channel content to the user's browser. 

10 

The user logs out or the session times out. 

11 

Portal Server closes the portlet session, if any, and Access Manager deletes the user's session object. 

The understanding of component interactions represented in the logical architecture can be used later in the design process when you estimate the load on different components for sizing purposes and when you create a network connectivity specification.

Deployment Architecture of the Reference Configuration

A deployment architectureis a mapping of software components to a hardware environment. More specifically, for the Portal Service on Application Server Cluster reference configuration, it represents how to map the components in the logical architecture to networked computers in a way that achieves the specified quality-of-service requirements.

The logical architecture in Figure 2–1 identifies the components that are needed to meet the functional requirements of the reference configuration. The deployment architecture, however, shows how to do so with the specified quality of service.

The following sections present the deployment architecture diagram and discuss how the deployment architecture addresses the quality-of-service requirements:

Summary of Quality-of-Service Requirements

The quality-of-service requirements for the portal service on Application Server Cluster reference configuration are summarized in the following table.

Table 2–4 Quality-of-Service Requirements for the Reference Configuration

Service Quality 

Requirements 

Performance 

Response time under two seconds for default portal channels at peak load levels. 

See Performance Requirements.

Availability 

Service availability with both user session availability and application session state availability.  

No single points of failure. 

See Availability Requirements.

Security 

Protected services in separate network subnets. 

Firewall protection for Internet access and for portal service subnet zone. 

Encrypted Internet transport over SSL. 

See Security Requirements.

Scalability 

Easily scalable so that no computer system is more than 80% utilized under daily peak load. Also the deployed system should accommodate long-term growth of 10% per year. 

See Scalability Requirements.

Serviceability 

Minimize planned downtime needed to scale the portal service or to upgrade software components in the configuration. 

See Serviceability Requirements.

Deployment Architecture Diagram

Figure 2–2 is a graphical representation of the deployment architecture for the Portal Service on Application Server Cluster reference configuration. It shows the following features of the deployment architecture:

Figure 2–2 Deployment Architecture of the Reference Configuration

Graphic representation of the deployment architecture
consisting of four modules, described in the text.

Modularity in the Deployment Architecture

The reference configuration deployment architecture is based on a Service Delivery Network Architecture (SDNA) approach, in which individual services within a solution are modularized (see https://wikis.sun.com/display/BluePrints/The+Service+Delivery+Network-+A+Case+Study). The result is a deployment architecture consisting of four independent service modules: SRA Gateway, portal, Access Manager, and directory.

In accordance with SDNA principles, each service module in the reference configuration independently implements its own level of availability, security, scalability, and serviceability. The overall solution can therefore be easily deployed, secured, maintained, and upgraded. An explanation of how the reference configuration's modular architecture facilitates quality-of-service objectives is provided in subsequent sections of this chapter.

The service modules that make up the reference configuration, shown in Figure 2–2, have the following common SDNA characteristics:

While the modular architecture depicted in Figure 2–2 has many advantages, as described in subsequent sections of this chapter, alternative approaches in common practice do exist. The drawbacks of two such alternatives, which are not supported by this reference configuration, are discussed below.

Not Supported: Portal Server and Access Manager Combined

In some situations, the modular architecture of Figure 2–2 might result in lower resource utilization than could be achieved by combining components on the same computer and running them in the same web container. In fact, many deployment architects have traditionally deployed Portal Server and Access Manager in the same web container in an effort to maximize resource utilization and reduce network traffic in updating Access Manager session information. However, such designs cannot realize the availability, security, scalability, and serviceability benefits of SDNA modularity, which generally outweigh the drawbacks.

Not Supported: Access Manager Internal Configuration for Multiple Directory Server Instances

Access Manager supports, by way of post-installation configuration, multiple LDAP directories for each Access Manger service. In this way, Access Manager can detect failure of a primary Directory Server instance and fail over to an standby instance. This built-in mechanism has several drawbacks:

By contrast, the modular architecture of Fig 2-2 has the following advantages:


Note –

In the multimaster replication approach of Figure 2-2, write operations are synchromized between directory instances. In environments with many write operations, the overhead of the multimaster replication process can slow down Directory Server processing of client requests. In these situations, the best approach is to direct all write operations to a single master by placing a Directory Proxy Server instance in front of each Directory Server instance. Such situations are not common in portal service deployments, so the reference configuration does not include Directory Proxy Server.


Availability in the Deployment Architecture

The deployment architecture that is represented in Figure 2–2 uses several strategies to meet the availability requirements of the reference configuration. Availability requirements fall into the two categories that are discussed in the following sections:

Service Availability

Service availability means that a service is available, even when a service provider fails. Service availability is generally achieved using multiple identically configured service instances (redundancy). Redundancy eliminates single points of failure (assuming that simultaneous failure of all instances is extremely unlikely). If one instance providing a service fails, another instance is available to take over. This mechanism is known as service failover.

Service failover is supported in the reference configuration through two mechanisms:

Session State Availability

Session state availability means that data associated with a user session is not lost during a service failover. When a service failover occurs, the session state data that is stored by the failed instance is made available to the failover instance. This mechanism is known as session failover. The result is that the service failover is transparent to the user: the user will not be required to log in again or to restart a business operation.

Session failover is supported in the reference configuration through two mechanisms:


Note –

When a user is successfully authenticated with Access Manager, the browser is redirected to a Portal Server instance. A portal desktop session is created on this instance and is mapped to the user's Access Manager session. This portal desktop session is used to track Portal Server specific information such as the user's merged display profile and provider properties. If a Portal Server instance fails, the desktop session is automatically re-created by using the user's display profile and attributes that are stored in the Access Manager's user session. However, provider properties that are stored in local memory are lost.


Security in the Deployment Architecture

The security requirements of the portal service reference configuration (see Security Requirements) are met through several mechanisms, each of which are discussed in the following sections:

Authentication and Authorization

Each user's access must be limited to the portal services and data channels that he or she is authorized to view.

The reference configuration uses Access Manager and Directory Server to control user access to portal content. The directory service maintains each user's portal desktop profile. This profile includes any desktop customization that is performed by the user, as well as mechanisms for determining what content the user is authorized to view.

Separate Administration

The modularized architecture makes it easy for different organizations to administer different service modules so that each organization has the level of administrative security it needs. In most enterprises, for example, directory services and Access Manager services are administered by security-oriented organizations, while portal services are administered by end-user applications organizations.

Network Segmentation

The portal service must be secured against unauthorized and unauthenticated access.

The deployment architecture uses a secure network topology for the portal service, which includes the use of firewalls, controlled access through load balancers with virtual service addresses, and private subnets behind the firewall.

Figure 2–2 shows a portal services zone in which the portal service, Access Manager service, and directory service modules are deployed behind the Internal Firewall. Within this zone, the deployment architecture protects the service modules in the following ways:

Not shown in Figure 2–2 is that the individual computers hosting service instances are hardened and that the operating system installations are minimized. Minimizing the number of installed Solaris OS packages means fewer security holes. Because the majority of system penetrations are through exploitation of operating system vulnerabilities, minimizing the number of installed operating system packages will reduce the number of vulnerabilities. Minimizing the operating system is covered in detail in Computer Hardware and Operating System Specification.

Secure Remote Access

The secure remote access option provides secure access to portal services, applications, and other content on an internal intranet to employees or customers on the public Internet. This option prevents such access to unauthorized people.

The requirement for secure remote access is met in the Portal Service on Application Server Cluster reference configuration through Portal Server SRA components, specifically the SRA Gateway service, and by network access zones, demarcated by firewalls, that take maximum advantage of the SRA Gateway service. The access zones and the firewalls are represented in Figure 2–2.

The outermost zone in Figure 2–2 is the so-called demilitarized zone, or DMZ, which contains the SRA Gateway service. The Gateway service can only be accessed through the External Firewall at one specific URL. Employees or customers who connect to the portal service with remote browser clients or mobile clients do so by accessing the Gateway service at the specified URL. The External Firewall blocks all other ports and addresses.

Because remote access to the portal service from the public Internet is through the Gateway service, the portal service itself can reside behind an additional firewall (the Internal Firewall) and an additional layer of hardware load balancing.

In addition to deploying the Gateway service behind an Internet-facing firewall, the deployment architecture secures the Gateway service in the following ways:

Scalability in the Deployment Architecture

The modular nature of the reference configuration's deployment architecture means that you can scale each module independently, depending on the kind of traffic that your portal service receives.

Each service module in the deployment architecture is composed of two or more service instances running on separate computers behind a load balancer. This architecture allows you to scale any of the modules vertically (by adding CPUs or memory to the host computers) or horizontally (by adding additional service instances). Some modules are better suited to vertical scaling, and some modules are better suited to horizontal scaling.

The recommended techniques for scaling each module in the reference configuration are as follows:

Serviceability in the Deployment Architecture

The reference configuration architecture builds the portal service out of several subservices, such as the Access Manager service and directory service. Because each subservice is implemented in a separate module, it is possible to maintain each module independently.

In addition, the reference configuration architecture creates each subservice as a virtual service, which means that interoperability among the subservices is not dependent on specific hardware connections, and the individual subservices are maintained, upgraded, replaced, and scaled without affecting each other. For example, if it is necessary to add an Access Manager instance to the architecture, the Portal Server instances that depend on Access Manager do not need to be modified or affected in any way.

Deployment Options for the Reference Configuration

Depending on your quality-of-service requirements, certain parts of the reference configuration can be changed or omitted. This section briefly discusses these options which include the following:

Omitting Portlet Session Failover

The reference configuration deployment architecture supports portlet session failover, as described in Session State Availability. It does this by deploying Portal Server in an Application Server cluster that uses High Availability Session Store (HADB) to store and replicate portlet session state.

If your business solution does not involve portlets that store session state, then portlet session failover might not be a requirement for your portal service deployment. If that is the case, you do not need to deploy Portal Server in an Application Server cluster. However, if you have other reasons beside portlet session failover for deploying Portal Server in an Application Server cluster, you can use this guide, but omit the section on implementing portlet session failover.

Portal Server can be deployed in a web container provided by nonclustered Application Server instances. This approach would substantially change the implementation of the portal service module described in Chapter 6, Implementation Module 3: Portal Server With Portlet Session Failover on Application Server Cluster.

At the present time, however, an alternative implementation for Portal Server on Application Server (without portlet session failover) has not yet been documented.

Omitting Access Manager Session Failover

The reference configuration deployment architecture supports Access Manager session failover, as described in Session State Availability. It does so by configuring Access Manager to use Message Queue and a highly available database to store and replicate Access Manager session state.

If your business solution permits users to log in again to reestablish a session after a service failover, then Access Manager session failover is not a requirement for your portal service deployment. If that is the case, you do not need to configure Access Manager for Access Manager session failover, and Message Queue would not be included as a component in the Access Manager service module. This approach would change the implementation of the Access Manager service module by not requiring the procedures in Implementing Session Failover for Access Manager .

Omitting Secure Remote Access

The reference configuration deployment architecture supports secure access to portal services, applications, and other content on an internal intranet to users on the public Internet. This feature is supported by the SRA Gateway module, as described in Secure Remote Access.

If your business solution does not require secure access to portal services, applications, and other content over the public Internet, then secure remote access is not a security requirement for your portal service deployment. For example, you might be using one of the following alternate scenarios to access the portal service:

In these scenarios, you can omit Chapter 7, Implementation Module 4: Secure Remote Access Gateway from the reference configuration architecture. However, depending on the scenario, you might need to modify the network topology of the reference configuration accordingly.

Using a Different Web Container

Two of the components in the reference configuration, Portal Server and Access Manager, run in web containers. The Java ES component set gives you the choice of using either Sun Java System Web Server or Sun Java System Application Server for a web container.

You need to consider both technical and non-technical factors when you choose a web container.

The following technical factors address the abilities of the different containers to run different types of portal content:

If none of the technical factors are decisive for your organization, the following non-technical considerations could prove decisive: