Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add /api/info endpoint #5

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Add /api/info endpoint
- returns library information: libraryExpireDays, dataExpireDays, and apiVersion
  • Loading branch information
Steven Cipriano committed Feb 17, 2018
commit 859803dacb190b639119b4dccbfdbad192087c4a
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
package gov.nysenate.ams.client.response;

public class LibraryInfoResponse
{
protected String apiVersion;
protected int dataExpireDays;
protected int libraryExpireDays;

public LibraryInfoResponse(String apiVersion, int dataExpireDays, int libraryExpireDays)
{
this.apiVersion = apiVersion;
this.dataExpireDays = dataExpireDays;
this.libraryExpireDays = libraryExpireDays;
}

public String getApiVersion() {
return apiVersion;
}

public int getDataExpireDays() {
return dataExpireDays;
}

public int getLibraryExpireDays() {
return libraryExpireDays;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
package gov.nysenate.ams.controller;

import gov.nysenate.ams.client.response.LibraryInfoResponse;
import gov.nysenate.ams.filter.ApiFilter;
import gov.nysenate.ams.provider.AmsNativeProvider;
import gov.nysenate.ams.util.Application;
import org.apache.log4j.Logger;

import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

/**
* Servlet to handle library info requests.
*/
public class LibraryInfoController extends BaseApiController
{
private Logger logger = Logger.getLogger(LibraryInfoController.class);
private AmsNativeProvider amsNativeProvider;

@Override
public void init(ServletConfig config) throws ServletException
{
this.amsNativeProvider = Application.getAmsNativeProvider();
logger.debug("Initialized LibraryInfoController.");
}

@Override
public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
{
processRequest(request, response);
}

@Override
public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

initially this was only going to support GET but the BaseApiController requires both doGet and doPost, so I had them both do the same thing. Open to suggestions if there is a preferred approach

{
processRequest(request, response);
}

private void processRequest(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
{
Object responseObj;

String apiVersion = amsNativeProvider.getApiVersion();
int dataExpireDays = amsNativeProvider.getDataExpireDays();
int libraryExpireDays = amsNativeProvider.getLibraryExpireDays();

responseObj = new LibraryInfoResponse(apiVersion, dataExpireDays, libraryExpireDays);

ApiFilter.setApiResponse(responseObj, request);
}
}
12 changes: 11 additions & 1 deletion src/main/webapp/WEB-INF/web.xml
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,14 @@
<url-pattern>/api/citystate/*</url-pattern>
</servlet-mapping>

</web-app>
<servlet>
<display-name>LibraryInfoController</display-name>
<servlet-name>LibraryInfoController</servlet-name>
<servlet-class>gov.nysenate.ams.controller.LibraryInfoController</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>LibraryInfoController</servlet-name>
<url-pattern>/api/info/*</url-pattern>
</servlet-mapping>

</web-app>