Page tree
Skip to end of metadata
Go to start of metadata

On this page:

Target audience:

Users of the extension providing JAX-RS support for Web Services.

Summary: This document provides basic information about the extension providing JAX-RS support for Web Services.

Extension ID

com.castsoftware.jaxrs

What's new?

See JAX-RS -1.4 - Release Notes for more information.

Description

This extension provides support for JAX-RS.

In what situation should you install this extension?

The main purpose of this extension is to create HTTP API entry points, to enable linking from a Web App front end. Therefore if your Web application contains source code which uses JAX-RS (1.0 (JSR 311) and 2.0 (JSR 339)) and you want to view these object types and their links with other objects, then you should install this extension. 

iOS Front-End ExampleAngularJS Front-End Example

Features

This extension handles JAX-RS Web Services used in J2EE applications, for example:

@Singleton
@Path("/printers")
public class PrintersResource {
     @GET
     @Produces({"application/json", "application/xml"})
     public WebResourceList getMyResources() { ... }
      
     @GET @Path("/list")
     @Produces({"application/json", "application/xml"})
     public WebResourceList getListOfPrinters() { ... }
   
     @PUT @Path("/ids/{printerid}")
     @Consumes({"application/json", "application/xml"})
     public void putPrinter(@PathParam("printerid") String printerId,  Printer printer) { ... }
    
     @DELETE @Path("/ids/{printerid}")
     public void deletePrinter(@PathParam("printerid") String printerId) { ... }
 }

For each class annotated with javax.ws.rs.Path (@Path):

  • A Web Service object will be created whose name is deduced from the value of @Path on the class
  • A Web Service Port object will be created that is a child of the web service with the same name and has with a prototype link to the class
  • For each method annotated with @GET, @PUT, @DELETE or @POST, the following will be created:
    • a Web Service operation child of the Web Service Port whose name is the concatenation of the @Path specified at the class level and the @Path specified at the method level. If no @Path on the method, then method path = /
    • a fire link from the Web Service operation to the method

Annotations considered

  • for the URLs:
    • javax.ws.rs.Path
  • for the access type:
    • javax.ws.rs.GET
    • javax.ws.rs.PUT
    • javax.ws.rs.DELETE
    • javax.ws.rs.POST

Basic case

The following Java code:

import javax.ws.rs.Path;
import javax.ws.rs.GET;


@Path("Service")
public class MyClass
{
    @Path("/getter")
    @GET
    public void getter() {}
}

will generate :

Inheritance case

The annotations may also be in the parent class or interface:

import javax.ws.rs.Path;


@Path("Service")
public class MyClass implements MyInterface
{
    public void getter() {}
}

Here the interface defines the exposed methods:

import javax.ws.rs.Path;
import javax.ws.rs.GET;


public interface MyInterface
{
    @Path("/getter")
    @GET
    public void getter();
}

and will generate :

Here the interface exposes the main path and the implementation defines the exposed methods:

import javax.ws.rs.Path;


public class MyClass implements MyInterface
{
    @Path("/getter")
    @GET
	public void getter() {}
}


import javax.ws.rs.Path;
import javax.ws.rs.GET;

@Path("Service")
public interface MyInterface
{

    public void getter();
}

and will generate :

Support for User Input Security

Service entry points are created automatically for applications that have a presentation layer based on JAX-RS with @Path (and associated annotations) usage. This can be seen in the analysis log file as follows:

2018-07-04 20:27:29,227 INFO  SecurityAnalyzer.Processor LoadBlackboxesForApplication cast#spec cast#lib JAXRSServiceEntryPoints


This corresponds to the generation of a file in the following location:

<BytecodeFolder>\com.castsoftware.jaxrs\ServiceEntryPoints.blackbox.xml


Note that while the ServiceEntryPoints.blackbox.xml file is generated when the extension is used with any release of CAST AIP, it will only be exploited by the CAST User Input Security feature in CAST AIP  8.3.3.

Support of WebTarget as a call to web service

Supported Call to Web Service from Java as well as to GetOperations by making the following links. 

  • Created the CallLink from java to Web Service named "JAX RS Get Resource Service".
  • Created the CallLink from Web Service to Get operations.


import java.net.URI;
import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.MediaType;
import org.glassfish.jersey.client.ClientConfig;
public class ClientTest {
  public static void main(String[] args) {
    ClientConfig config = new ClientConfig();
    Client client = ClientBuilder.newClient(config);
    WebTarget target = client.target(getBaseURI());
    System.out.println(target.path("rest").path("hello").request().accept(MediaType.TEXT_PLAIN).get(String.class));
  }
} 


Function Point, Quality and Sizing support

This extension provides the following support:

  • Function Points (transactions): a green tick indicates that OMG Function Point counting and Transaction Risk Index are supported
  • Quality and Sizing: a green tick indicates that CAST can measure size and that a minimum set of Quality Rules exist
Function Points
(transactions)
Quality and Sizing
(tick)(error)

CAST AIP compatibility

This extension is compatible with:

CAST AIP release
Supported
8.3.x(tick)
8.2.x(tick)
8.1.x(tick)
8.0.x(tick)
7.3.4 and all higher 7.3.x releases(tick)

Supported DBMS servers

This extension is compatible with the following DBMS servers:

CAST AIP releaseCSSOracleMicrosoft
All supported releases(tick)(tick)(error)

Prerequisites

(tick)An installation of any compatible release of CAST AIP (see table above)

Dependencies with other extensions

Some CAST extensions require the presence of other CAST extensions in order to function correctly. The JAX-RS extension requires that the following other CAST extensions are also installed:

  • Web services linker service (internal technical extension)
Note that when using the CAST Extension Downloader to download the extension and the Manage Extensions interface in CAST Server Manager to install the extension, any dependent extensions are automatically downloaded and installed for you. You do not need to do anything.

Download and installation instructions

Please see:

The latest release status of this extension can be seen when downloading it from the CAST Extend server.

CAST Transaction Configuration Center (TCC) Entry Points

In JAX-RS ≥ 1.3.x, if you are using the extension with CAST AIP ≥ 8.3.x, a set of JAX-RS specific Transaction Entry Points are now automatically imported when the extension is installed. These Transaction Entry Points will be available in the CAST Transaction Configuration Center:

Manual import action for CAST AIP ≤ 8.2.x

 Click here to expand...
  • Locate the .TCCSetup file in the extension folder: Configuration\TCC\Base_Java_JAXRS.TCCSetup

  • In the CAST Transaction Configuration Center, ensure you have selected the Templates node:

  • This .TCCSetup file is to be imported into the CAST Transaction Calibration Center using either the:

    • File > Import Configuration menu option:

    • Or right clicking on the Template node and selecting Import Configuration:

  • The import of the "Base_Java_JAXRS.TCCSetup" file will provide you with a sample Transaction Entry point in the Free Definition node under Templates:

  • Now right click the "Standard Entry Point" item and select copy:

  • Paste the item into the equivalent node under the Application, for example, below we have copied it into the Application MEUDON:

  • Repeat for any additional items or generic sets that have been imported from the .TCCSetup file.

Packaging, delivering and analyzing your source code

Once the extension is installed, no further configuration changes are required before you can package your source code and run an analysis. The process of packaging, delivering and analyzing your source code does not change in any way:

  • Package and deliver your application (that includes source code which uses JAX-RS) in the exact same way as you always have. 
  • Analyze your delivered application source code in the CAST Management Studio in the exact same way as you always have - the source code which uses JAX-RS will be detected and handled correctly.

What results can you expect?

Once the analysis/snapshot generation has completed, HTTP API transaction entry points will be available for use when configuring the CAST Transaction Configuration Center. In addition, you can view the results in the normal manner (for example via CAST Enlighten).

Objects

The following objects are displayed in CAST Enlighten:

IconDescription

JAX-RS Delete Operation Service

JAX-RS Get Operation Service

JAX-RS Post Operation Service

JAX-RS Put Operation Service

JAX-RS Port

JAX-RS Service

JAX-RS Get Resource Service

Rules

None.

  • No labels