Package server.restful

Klasse JSIDPlay2Server

java.lang.Object

server.restful.JSIDPlay2Server

public final class JSIDPlay2Server
extends Object

Use this class to start JSIDPlay2 in server mode!

Server part of JSIDPlay2 to answer server requests like:

1st) get a stream with SID music as MP3 for the mobile version or

2nd) get a stream of a C64 demo as RTMP stream for the mobile version or

3rd) WhatsSID? Which tune is currently played?

Autor:

ken

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
private static class	JSIDPlay2Server.HealthCheckResult
static class	JSIDPlay2Server.JSIDPlay2ServerParameters

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
private static final Map<Class<?>,Object>	CDI
private static final ConfigService.ConfigurationType	CONFIGURATION_TYPE
static final String	CONTEXT_ROOT	Context root of web app
static final String	CONTEXT_ROOT_SERVLET	Context root of all servlets
static final String	CONTEXT_ROOT_START_PAGE	Context root of start page
static final String	CONTEXT_ROOT_STATIC	Context root of static pages
static final String	CONTEXT_ROOT_WEBJARS	Context root of webjars
private static javax.persistence.EntityManagerFactory	DEBUG_ENTITY_MANAGER_FACTORY
private static javax.persistence.EntityManagerFactory	ENTITY_MANAGER_FACTORY
private static final URL	FILTER_CLASSES_LIST
private static JSIDPlay2Server	INSTANCE
private static final URL	INTERNAL_REALM_CONFIG	Configuration of usernames, passwords, and roles
private static final Logger	LOG
private final JSIDPlay2Server.JSIDPlay2ServerParameters	parameters
static final String	REALM_CONFIG	Filename of the configuration containing username, password, and role.
static final String	REALM_NAME	Realm name
static final String	ROLE_ADMIN	Admin role
static final String	ROLE_USER	User role
private static final URL	SERVLET_CLASSES_LIST
static final String	SERVLET_UTIL_CONFIG_FILE	Filename of the configuration file to access additional directories.
private static javax.persistence.EntityManagerFactory	STATISTICS_ENTITY_MANAGER
private static final ThreadLocal<javax.persistence.EntityManager>	THREAD_LOCAL_DEBUG_ENTITY_MANAGER
private static final ThreadLocal<javax.persistence.EntityManager>	THREAD_LOCAL_ENTITY_MANAGER
private static final ThreadLocal<javax.persistence.EntityManager>	THREAD_LOCAL_STATISTICS_ENTITY_MANAGER
private Timer	timer
private org.apache.catalina.startup.Tomcat	tomcat
static final String	URL_SCHEMA

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
private	JSIDPlay2Server()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
private org.apache.catalina.Context	addContext(org.apache.catalina.startup.Tomcat tomcat)
private static void	addDatabaseAppender()
private void	addHealthCheckValve(org.apache.catalina.startup.Tomcat tomcat)
private static void	addRemoteIpValve(org.apache.catalina.startup.Tomcat tomcat)
private void	addServletFilters(org.apache.catalina.Context context, List<jakarta.servlet.Servlet> servlets)
private List<jakarta.servlet.Servlet>	addServlets(org.apache.catalina.Context context)
private void	addServletSecurity(org.apache.catalina.Context context, List<jakarta.servlet.Servlet> servlets)
private static JSIDPlay2Server.HealthCheckResult	checkHealthy(boolean httpEnabled, boolean httpsEnabled, String hostname, int httpPort, int httpsPort)
private static JSIDPlay2Server	create(Configuration configuration)
private org.apache.catalina.connector.Connector	createHttpConnector(EmulationSection emulationSection)
private org.apache.catalina.connector.Connector	createHttpsConnector(EmulationSection emulationSection)
private jakarta.servlet.MultipartConfigElement	createMultipartConfigElement(jakarta.servlet.annotation.WebServlet webServlet, jakarta.servlet.annotation.MultipartConfig multipartConfig)
private org.apache.catalina.startup.Tomcat	createTomcat()
private static void	exit(int rc)
static void	freeDebugEntityManager()
static void	freeEntityManager()
private static void	freeEntityManager(ThreadLocal<javax.persistence.EntityManager> threadLocalEntityManager)
static void	freeStatisticsEntityManager()
static javax.persistence.EntityManager	getDebugEntityManager()
static javax.persistence.EntityManager	getEntityManager()
private static javax.persistence.EntityManager	getEntityManager(javax.persistence.EntityManagerFactory entityManagerFactory, ThreadLocal<javax.persistence.EntityManager> threadLocalEntityManager)
private Map<String,String>	getFilterParameters(jakarta.servlet.http.HttpFilter servletFilter, jakarta.servlet.Servlet servlet)
static JSIDPlay2Server	getInstance(Configuration configuration)
static JSIDPlay2Server	getInstance(Configuration configuration, Runnable configSaver)
private URL	getRealmConfigURL()	Search for a user, password, and role configuration file. Note:If no configuration file is found internal configuration is used
private Properties	getServletUtilProperties()	Search for configuration of additional accessible directories.
private static org.apache.tomcat.util.net.SSLHostConfig	getSslHostConfig(EmulationSection emulationSection)
static javax.persistence.EntityManager	getStatisticsEntityManager()
private void	inject(Class<?> cls, Object obj)
static void	main(String[] args)
private static void	printStartupInfo(Configuration configuration)
private void	setConnectors(org.apache.catalina.startup.Tomcat tomcat)
private void	setRealm(org.apache.catalina.startup.Tomcat tomcat)
void	start()
void	stop()
private static boolean	urlReachable(String url)

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Felddetails

LOG

private static final Logger LOG

URL_SCHEMA

public static final String URL_SCHEMA

Siehe auch:

• Konstantenfeldwerte

CONTEXT_ROOT

public static final String CONTEXT_ROOT

Context root of web app

Siehe auch:

• Konstantenfeldwerte

CONTEXT_ROOT_START_PAGE

public static final String CONTEXT_ROOT_START_PAGE

Context root of start page

Siehe auch:

• Konstantenfeldwerte

CONTEXT_ROOT_STATIC

public static final String CONTEXT_ROOT_STATIC

Context root of static pages

Siehe auch:

• Konstantenfeldwerte

CONTEXT_ROOT_WEBJARS

public static final String CONTEXT_ROOT_WEBJARS

Context root of webjars

Siehe auch:

• Konstantenfeldwerte

CONTEXT_ROOT_SERVLET

public static final String CONTEXT_ROOT_SERVLET

Context root of all servlets

Siehe auch:

• Konstantenfeldwerte

ROLE_USER

public static final String ROLE_USER

User role

Siehe auch:

• Konstantenfeldwerte

ROLE_ADMIN

public static final String ROLE_ADMIN

Admin role

Siehe auch:

• Konstantenfeldwerte

SERVLET_UTIL_CONFIG_FILE

public static final String SERVLET_UTIL_CONFIG_FILE

Filename of the configuration file to access additional directories.

e.g. "/MP3=/media/nas1/mp3,true" (top-level logical directory name=real directory name, is an admin role required?)

Siehe auch:

• Konstantenfeldwerte

REALM_NAME

public static final String REALM_NAME

Realm name

Siehe auch:

• Konstantenfeldwerte

REALM_CONFIG

public static final String REALM_CONFIG

Filename of the configuration containing username, password, and role. For an example, please refer to the internal resource tomcat-users.xml

Siehe auch:

• Konstantenfeldwerte

INTERNAL_REALM_CONFIG

private static final URL INTERNAL_REALM_CONFIG

Configuration of usernames, passwords, and roles

SERVLET_CLASSES_LIST

private static final URL SERVLET_CLASSES_LIST

FILTER_CLASSES_LIST

private static final URL FILTER_CLASSES_LIST

INSTANCE

private static JSIDPlay2Server INSTANCE

ENTITY_MANAGER_FACTORY

private static javax.persistence.EntityManagerFactory ENTITY_MANAGER_FACTORY

DEBUG_ENTITY_MANAGER_FACTORY

private static javax.persistence.EntityManagerFactory DEBUG_ENTITY_MANAGER_FACTORY

STATISTICS_ENTITY_MANAGER

private static javax.persistence.EntityManagerFactory STATISTICS_ENTITY_MANAGER

CDI

private static final Map<Class<?>,Object> CDI

THREAD_LOCAL_ENTITY_MANAGER

private static final ThreadLocal<javax.persistence.EntityManager> THREAD_LOCAL_ENTITY_MANAGER

THREAD_LOCAL_DEBUG_ENTITY_MANAGER

private static final ThreadLocal<javax.persistence.EntityManager> THREAD_LOCAL_DEBUG_ENTITY_MANAGER

THREAD_LOCAL_STATISTICS_ENTITY_MANAGER

private static final ThreadLocal<javax.persistence.EntityManager> THREAD_LOCAL_STATISTICS_ENTITY_MANAGER

CONFIGURATION_TYPE

private static final ConfigService.ConfigurationType CONFIGURATION_TYPE

parameters

private final JSIDPlay2Server.JSIDPlay2ServerParameters parameters

tomcat

private org.apache.catalina.startup.Tomcat tomcat

timer

private Timer timer

Konstruktordetails

JSIDPlay2Server

private JSIDPlay2Server()

Methodendetails

getInstance

public static JSIDPlay2Server getInstance(Configuration configuration)

getInstance

public static JSIDPlay2Server getInstance(Configuration configuration,
 Runnable configSaver)

create

private static JSIDPlay2Server create(Configuration configuration)

start

public void start()
           throws InstantiationException,
IllegalAccessException,
IllegalArgumentException,
InvocationTargetException,
NoSuchMethodException,
SecurityException,
org.apache.catalina.LifecycleException,
ClassNotFoundException,
IOException

Löst aus:

InstantiationException

IllegalAccessException

IllegalArgumentException

InvocationTargetException

NoSuchMethodException

SecurityException

org.apache.catalina.LifecycleException

ClassNotFoundException

IOException

stop

public void stop()
          throws org.apache.catalina.LifecycleException

Löst aus:

org.apache.catalina.LifecycleException

getServletUtilProperties

private Properties getServletUtilProperties()

Search for configuration of additional accessible directories. Search in CWD and in the HOME folder.

createTomcat

private org.apache.catalina.startup.Tomcat createTomcat()
                                                 throws InstantiationException,
IllegalAccessException,
IllegalArgumentException,
InvocationTargetException,
NoSuchMethodException,
SecurityException,
ClassNotFoundException,
IOException

Löst aus:

InstantiationException

IllegalAccessException

IllegalArgumentException

InvocationTargetException

NoSuchMethodException

SecurityException

ClassNotFoundException

IOException

addHealthCheckValve

private void addHealthCheckValve(org.apache.catalina.startup.Tomcat tomcat)

addRemoteIpValve

private static void addRemoteIpValve(org.apache.catalina.startup.Tomcat tomcat)

setRealm

private void setRealm(org.apache.catalina.startup.Tomcat tomcat)
               throws MalformedURLException

Löst aus:

MalformedURLException

getRealmConfigURL

private URL getRealmConfigURL()
                       throws MalformedURLException

Search for a user, password, and role configuration file.
Note:If no configuration file is found internal configuration is used

Gibt zurück:

user, password, and role configuration file

Löst aus:

MalformedURLException - error locating the realm configuration

setConnectors

private void setConnectors(org.apache.catalina.startup.Tomcat tomcat)

createHttpConnector

private org.apache.catalina.connector.Connector createHttpConnector(EmulationSection emulationSection)

createHttpsConnector

private org.apache.catalina.connector.Connector createHttpsConnector(EmulationSection emulationSection)

getSslHostConfig

private static org.apache.tomcat.util.net.SSLHostConfig getSslHostConfig(EmulationSection emulationSection)

addContext

private org.apache.catalina.Context addContext(org.apache.catalina.startup.Tomcat tomcat)

addServlets

private List<jakarta.servlet.Servlet> addServlets(org.apache.catalina.Context context)
                                           throws InstantiationException,
IllegalAccessException,
IllegalArgumentException,
InvocationTargetException,
NoSuchMethodException,
SecurityException,
IOException,
ClassNotFoundException

Löst aus:

InstantiationException

IllegalAccessException

IllegalArgumentException

InvocationTargetException

NoSuchMethodException

SecurityException

IOException

ClassNotFoundException

inject

private void inject(Class<?> cls,
 Object obj)
             throws IllegalAccessException

Löst aus:

IllegalAccessException

createMultipartConfigElement

private jakarta.servlet.MultipartConfigElement createMultipartConfigElement(jakarta.servlet.annotation.WebServlet webServlet,
 jakarta.servlet.annotation.MultipartConfig multipartConfig)

addServletFilters

private void addServletFilters(org.apache.catalina.Context context,
 List<jakarta.servlet.Servlet> servlets)
                        throws InstantiationException,
IllegalAccessException,
IllegalArgumentException,
InvocationTargetException,
NoSuchMethodException,
SecurityException,
IOException,
ClassNotFoundException

Löst aus:

InstantiationException

IllegalAccessException

IllegalArgumentException

InvocationTargetException

NoSuchMethodException

SecurityException

IOException

ClassNotFoundException

getFilterParameters

private Map<String,String> getFilterParameters(jakarta.servlet.http.HttpFilter servletFilter,
 jakarta.servlet.Servlet servlet)

addServletSecurity

private void addServletSecurity(org.apache.catalina.Context context,
 List<jakarta.servlet.Servlet> servlets)

exit

private static void exit(int rc)

main

public static void main(String[] args)

printStartupInfo

private static void printStartupInfo(Configuration configuration)

checkHealthy

private static JSIDPlay2Server.HealthCheckResult checkHealthy(boolean httpEnabled,
 boolean httpsEnabled,
 String hostname,
 int httpPort,
 int httpsPort)

urlReachable

private static boolean urlReachable(String url)

addDatabaseAppender

private static void addDatabaseAppender()

getEntityManager

public static javax.persistence.EntityManager getEntityManager()
                                                        throws IOException

Löst aus:

IOException

freeEntityManager

public static void freeEntityManager()

getDebugEntityManager

public static javax.persistence.EntityManager getDebugEntityManager()
                                                             throws IOException

Löst aus:

IOException

freeDebugEntityManager

public static void freeDebugEntityManager()

getStatisticsEntityManager

public static javax.persistence.EntityManager getStatisticsEntityManager()
                                                                  throws IOException

Löst aus:

IOException

freeStatisticsEntityManager

public static void freeStatisticsEntityManager()

getEntityManager

private static javax.persistence.EntityManager getEntityManager(javax.persistence.EntityManagerFactory entityManagerFactory,
 ThreadLocal<javax.persistence.EntityManager> threadLocalEntityManager)
                                                         throws IOException

Löst aus:

IOException

freeEntityManager

private static void freeEntityManager(ThreadLocal<javax.persistence.EntityManager> threadLocalEntityManager)