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.

Sign up for GitHub

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

feat: Repurposed plain text status checks for the APIs into simple json check. #6962

Merged
merged 3 commits into from
Jan 3, 2024
Merged

feat: Repurposed plain text status checks for the APIs into simple json check. #6962

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c806c37
Repurposed plain text status checks for the APIs into simple json check.
wjrsimpson Jan 2, 2024
5ee56bc
Merge branch 'main' into statusCheckChanges
wjrsimpson Jan 2, 2024
7cb41ff
Corrected white space.
wjrsimpson Jan 2, 2024
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
8 changes: 5 additions & 3 deletions orcid-api-web/src/main/java/org/orcid/api/memberV3/server/MemberV3ApiServiceImplV3_0.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,10 +163,12 @@ public Response viewSwaggerO2c() {
* @return Plain text message indicating health of service
*/
@GET
@Produces(value = { MediaType.TEXT_PLAIN })
@Produces(value = { MediaType.APPLICATION_JSON })
@Path(STATUS_PATH)
public Response viewStatusText() {
return serviceDelegator.viewStatusText();
public Response viewStatusSimple() {
httpRequest.setAttribute("skipAccessLog", true);
httpRequest.setAttribute("isMonitoring", true);
return serviceDelegator.viewStatusSimple();
}

@GET
Expand Down
2 changes: 1 addition & 1 deletion ...eb/src/main/java/org/orcid/api/memberV3/server/delegator/MemberV3ApiServiceDelegator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ public interface MemberV3ApiServiceDelegator<DISTINCTION, EDUCATION, EMPLOYMENT,

static final String LATEST_V3_VERSION = "3.0";

Response viewStatusText();
Response viewStatusSimple();

Response viewStatus();

Expand Down
5 changes: 3 additions & 2 deletions ...in/java/org/orcid/api/memberV3/server/delegator/impl/MemberV3ApiServiceDelegatorImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,8 +278,9 @@ public void setFilterVersionOfIdentifiers(Boolean filterVersionOfIdentifiers) {
}

@Override
public Response viewStatusText() {
return Response.ok(STATUS_OK_MESSAGE).build();
public Response viewStatusSimple() {
Map<String, Boolean> statusMap = statusManager.createStatusMapSimple();
return Response.ok(statusMap).build();
}

@Override
Expand Down
1 change: 1 addition & 0 deletions orcid-api-web/src/main/resources/orcid-api-security-context.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
<sec:http pattern="/v3**/o2c.html" security="none"/>

<!-- Status check -->
<sec:http pattern="/v*/status" security="none"/>
<sec:http pattern="/v*/apiStatus" security="none"/>

<!-- Authenticate the client before reaching the token endpoint -->
Expand Down
2 changes: 2 additions & 0 deletions orcid-core/src/main/java/org/orcid/core/manager/StatusManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,7 @@ public interface StatusManager {
String TOMCAT_UP = "tomcatUp";

Map<String, Boolean> createStatusMap();

Map<String, Boolean> createStatusMapSimple();

}
7 changes: 7 additions & 0 deletions orcid-core/src/main/java/org/orcid/core/manager/impl/StatusManagerImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,13 @@ public Map<String, Boolean> createStatusMap() {
return result;
}

@Override
public Map<String, Boolean> createStatusMapSimple() {
Map<String, Boolean> result = new LinkedHashMap<>();
result.put(TOMCAT_UP, true);
return result;
}

private boolean isConnectionOk(MiscDao miscDao) {
try {
Date dbDate = miscDao.retrieveDatabaseDatetime();
Expand Down
8 changes: 5 additions & 3 deletions orcid-pub-web/src/main/java/org/orcid/api/publicV3/server/PublicV3ApiServiceImplV3_0.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,10 +128,12 @@ public Response viewSwagger() {


@GET
@Produces(value = { MediaType.TEXT_PLAIN })
@Produces(value = { MediaType.APPLICATION_JSON })
@Path(STATUS_PATH)
public Response viewStatusText() {
return serviceDelegator.viewStatusText();
public Response viewStatusSimple() {
httpRequest.setAttribute("skipAccessLog", true);
httpRequest.setAttribute("isMonitoring", true);
return serviceDelegator.viewStatusSimple();
}

@GET
Expand Down
2 changes: 1 addition & 1 deletion ...eb/src/main/java/org/orcid/api/publicV3/server/delegator/PublicV3ApiServiceDelegator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public interface PublicV3ApiServiceDelegator<DISTINCTION, EDUCATION, EMPLOYMENT,

static final String LATEST_V3_VERSION = "3.0";

Response viewStatusText();
Response viewStatusSimple();

Response viewStatus();

Expand Down
5 changes: 3 additions & 2 deletions ...in/java/org/orcid/api/publicV3/server/delegator/impl/PublicV3ApiServiceDelegatorImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,8 +226,9 @@ public void setFilterVersionOfIdentifiers(Boolean filterVersionOfIdentifiers) {
}

@Override
public Response viewStatusText() {
return Response.ok(STATUS_OK_MESSAGE).build();
public Response viewStatusSimple() {
Map<String, Boolean> statusMap = statusManager.createStatusMapSimple();
return Response.ok(statusMap).build();
}

@Override
Expand Down
4 changes: 2 additions & 2 deletions ...rg/orcid/api/publicV3/server/delegator/impl/PublicV3ApiServiceVersionedDelegatorImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ public void setPublicV3ApiServiceDelegator(
}

@Override
public Response viewStatusText() {
return publicV3ApiServiceDelegator.viewStatusText();
public Response viewStatusSimple() {
return publicV3ApiServiceDelegator.viewStatusSimple();
}

@Override
Expand Down
Loading