Skip to main content

Improve your REST Webservice response time using java.util.TimerTask

A while ago, I built an MAF application, which was consuming a few REST webservices from Oracle Java Cloud. But for each request from the app, the response JSON was getting created, and which made the app response very slow. 
So, I created the contents of the REST response as a scheduled job. My data wasn't getting changed that often, so I choose to build my REST responses every morning at 10am using java.util.TimerTask.

Used Software: JDeveloper 12.1.3

#1. REST response POJOs :
public class Feed {
   
    public String url;
    public String source;
   
    public Feed() {
        super();
    }
   
    public Feed(String source, String url) {
        setSource(source);
        setUrl(url);
    }
   
    public void setSource(String source) {
        this.source = source;
    }

    public String getSource() {
        return source;
    }

    public void setUrl(String url) {
        this.url = url;
    }

    public String getUrl() {
        return url;
    }
}


================================

@XmlRootElement(name = "feeds")
public class FeedsArray {

    private List<Feed> feeds;

    public void setFeeds(List<Feed> feeds) {
        this.feeds = feeds;
    }

    public List<Feed> getFeeds() {
        return feeds;
    }
}


#2. TimerTask class :
You need to create a class which extends java.util.TimerTask and override run() to put your custom code.
I have used a Singleton object (Feeds) to create and store my response.

public class FeedRSSScheduler extends TimerTask {
    public FeedRSSScheduler() {
        super();
    }

    @Override
    public void run() {
        Feeds.getInstance().buildFeedsMap();
    }
}


============================

public class Feeds {
   
    private static Feeds instance = null;
   
    private FeedsArray feedsArray;
   
    protected Feeds() {
        super();
    }
   
    public static Feeds getInstance() {
      if(instance == null) {
         instance = new Feeds();
      }
      return instance;
    }


    public FeedsArray getFeedsArray() {
        if(feedsArray == null) {
            buildFeedsMap();
        }
        return feedsArray;
    }
   
    public void buildFeedsMap() {
        // PUT your custom code here to populate the FeedsArray object

    }
}


#3. Servlet container class :
 
public class JobSchedulerServlet extends ServletContainer {
   
    private final static long ONCE_PER_DAY = 1000*60*60*24;
    private final static int TEN_AM = 10;
    private final static int ZERO_MINUTES = 0;
   
    public JobSchedulerServlet(Application application) {
        super(application);
    }

    @Override
    public void init() throws ServletException {   
        startFeedRSSTask();
        super.init();
    }

    public JobSchedulerServlet(Class<? extends Application> class1) {
        super(class1);
    }

    public JobSchedulerServlet() {
        super();
    }
   
    private Date getTomorrowMorning10AM(){
        Date date2am = new Date();
        date2am.setHours(TEN_AM);
        date2am.setMinutes(ZERO_MINUTES);
        return date2am;
    }
   
    private void startFeedRSSTask(){
        FeedRSSScheduler feedRSSScheduler = new FeedRSSScheduler();
        Timer timer = new Timer(); 
        timer.schedule(feedRSSScheduler, getTomorrowMorning10AM(), ONCE_PER_DAY);
    }
}


#4. Register your Servlet container class in web.xml :
  <servlet>
    <servlet-name>jersey</servlet-name>
    <servlet-class>rest.scheduler.JobSchedulerServlet</servlet-class>
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>jersey</servlet-name>
    <url-pattern>/*</url-pattern>
  </servlet-mapping>


#5. Create REST service :

@Path("/feeds")
public class FeedMap {
   
    @GET
    @Path("/sources")
    @Produces(MediaType.APPLICATION_JSON)
    public FeedsArray getFeedsMap() {
        return Feeds.getInstance().getFeedsArray();
    }
}

/// URL to access this service : http://<server>:<port>/<context_root>/feeds/sources

That's it. When you create and deploy this WAR file, the job will start instantly and then every day morning at 10am.

Comments

Post a Comment

Popular posts from this blog

Rich Text Editor - Oracle JET

Oracle JET has a lot of excellent UI components, but according to Murphy's law, client always comes up with something which you don't have at your disposal. So, driven by one of my client's requirements, I created a Rich Text Editor or WYSIWYG editor for Oracle JET. This is based on Quill JS and fully customizable. Github project download: https://github.com/sohamda/JET-Web-Components/tree/master/rich-text-editor I will explain in this blog, on how to integrate it in your own Oracle JET project. 1. Create and initialize your JET application and then put the downloaded web component inside "src\js\jet-composites" folder. 2. Once copied update your viewModel first. Add a snippet for passing the default content to be displayed by the editor after load. 3. Update view to load this editor Above you can see the "toolbar-options" property, that controls which options you should display to user on the editor. Those are basically the forma...

Exception Handling in ADF

This blog will give you an overview on how you can successfully deal with unhandled Runtime exceptions in an ADF application. This will give you an idea of: How to catch the unhandled exceptions. Write a separate log file with stacktrace and thread dumps. Redirect the user to an static error page #1. Catch unhandled exceptions :  Create a class "MyExceptionHandler" which extends : oracle.adf.view.rich.context.ExceptionHandler. Override handleException() method.     public void handleException(FacesContext facesContext, Throwable throwable, PhaseId phaseId) throws Throwable {         // this method is going to create a separate file with stacktrace and thread dumps         writeException(throwable);         // redirect to error page         redirectToErrorPage(facesContext);     }  Create a fo...

Layout Management & CSS Classes with Oracle JET

Oracle JET provides automatic responsive layout using CSS classes. So that, from large screens to small screens the application fits itself the best possible way. JET’s layout management are based on 2 types of CSS classes “Responsive Grid” and “Flex”. Responsive grid classes which deals with size, number of columns and functions of a particular <div>. Naming convention of these classes are oj- size - function - columns sizes can be: sm, md, lg, xl functions can be: hide, only-hide columns can be: any number between 1 to 12.   Just like Bootstrap, JET also divides the width of the available space into 12 columns, so for example, if you want a section of your page should take up atleast 5 columns if you divide the available screen into 12 columns, you need use : oj- size -5. Now comes the size part, you need to define that for each size of the screen, from hand-held mobile devices to large or extra large desktop screens. With combination with theses gr...