-
Notifications
You must be signed in to change notification settings - Fork 6
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
Closed
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
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
There are no files selected for viewing
27 changes: 27 additions & 0 deletions
27
src/main/java/gov/nysenate/ams/client/response/LibraryInfoResponse.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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; | ||
} | ||
} |
54 changes: 54 additions & 0 deletions
54
src/main/java/gov/nysenate/ams/controller/LibraryInfoController.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
{ | ||
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); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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 theBaseApiController
requires bothdoGet
anddoPost
, so I had them both do the same thing. Open to suggestions if there is a preferred approach