I’m currently running Openfire 4.7.0 Alpha with the downloaded REST-API 1.6.0 plugin (which works)
But, when I download the source code for REST-API 1.6.0 or 1.10.1 and add a method I only get a HTTP 302 response. Not only for the new method but for all.
Is there anything special that I need to do in my build when I want to deploy my own compiled plugin?
Example request
# curl -v http://myhostname.com:9090/plugins/restapi/v1/system/statistics/sessions -H "Accept: application/json" -H "Authorization:Basic ....."
* Trying IP...
* TCP_NODELAY set
* Connected to myhostname.com (IP) port 9090 (#0)
> GET /plugins/restapi/v1/system/statistics/sessions HTTP/1.1
> Host: myhostname.com:9090
> User-Agent: curl/7.61.1
> Accept: application/json
> Authorization:Basic .....
>
< HTTP/1.1 302 Found
< Date: Wed, 15 Nov 2023 09:58:11 GMT
< X-Frame-Options: SAMEORIGIN
< Set-Cookie: JSESSIONID=node021gwpvb7trcq1372oazjklaf40.node0; Path=/; HttpOnly
< Expires: Thu, 01 Jan 1970 00:00:00 GMT
< Location: http://myhostname.com:9090/login.jsp?url=%2Fplugins%2Frestapi%2Fv1%2Fsystem%2Fstatistics%2Fsessions
< Content-Length: 0
<
* Connection #0 to host myhostname.com left intact
Hi Stefan! I can’t think of anything that would cause this, or anthing ‘special’ that you’d need to do.
If you’re not using the exact same name for your custom plugin, maybe the properties aren’t loaded properly, which effectively gives your plugin a different configuration - maybe that’s the cause?
I just cloned the git-repo for 1.6.0 and added my code and compiled using mvn.
Mvn created restAPI-openfire-plugin-assembly.jar as output. I renamed it to restAPI.jar and copied it to the server so it extracts in the exact same folder as the standard REST-API jar.
But the error I get doesn’t seem to be from the plugin itself. It’s from WebManager that is a part of the xmpp-server. Atleast that is the only place where I can find the errormessage that is thrown.
This is the code I added. It’s for getting a session-count based on username = %search%
SessionController.java
public WCSessionsCount getWildcardSessionsCount(String userSearch) throws ServiceException {
Collection<ClientSession> clientSessions = SessionManager.getInstance().getSessions();
int count = 0;
for (ClientSession clientSession : clientSessions) {
try {
if(userSearch != null && clientSession.getUsername().contains(userSearch)) {
count++;
}
} catch (UserNotFoundException e) {
throw new ServiceException("Could not get user", "", ExceptionType.USER_NOT_FOUND_EXCEPTION,
Response.Status.NOT_FOUND, e);
}
}
return new WCSessionsCount(userSearch, count);
}
I have a lot of devices from different manufacturers that talk to my XMPP-server and I want to be able to graph the number of active sessions per device-model that is reflected in the username of the device.
Have you tried restarting Openfire after you deployed the plugin? Maybe some kind of issue prevents the authentication mechanism to re-initialize.
Review not only openfire.log, but also look for the console-out (either in a window somewhere, or in a file called nohup.out). Maybe those contain clues.
There was a conflict on the url …/sessions since both of theese methods handled the same endpoint. One with no arguments and one with ?search=xxx and they didn’t return the same data structure.
I got this message when restarting Openfire (I must have made som log-changes to get standard out because I didn’t get this earlier)
Nov 16, 2023 10:20:14 AM com.sun.jersey.spi.inject.Errors processErrorMessages
SEVERE: The following errors and warnings have been detected with resource and/or provider classes:
SEVERE: Producing media type conflict. The resource methods
public org.jivesoftware.openfire.plugin.rest.entity.WCSessionsCount org.jivesoftware.openfire.plugin.rest.service.SessionService.getWildcardUserSessionCount(java.lang.String) throws org.jivesoftware.openfire.plugin.rest.exceptions.ServiceException
and
public org.jivesoftware.openfire.plugin.rest.entity.SessionEntities org.jivesoftware.openfire.plugin.rest.service.SessionService.getAllSessions() throws org.jivesoftware.openfire.plugin.rest.exceptions.ServiceException
can produce the same media type
Successfully loaded plugin ‘restapi’.
So I added Path to the WCSessionCount to get it to work.
.