From af50923fe745e4d147b6ef80f3de3bdac30153ea Mon Sep 17 00:00:00 2001 From: Etzelia Date: Thu, 15 Aug 2019 17:17:01 +0200 Subject: [PATCH] Rename and cleanup (#5) --- docs/allclasses-frame.html | 10 +- docs/allclasses-noframe.html | 10 +- docs/constant-values.html | 4 +- docs/deprecated-list.html | 6 +- docs/help-doc.html | 4 +- docs/index-files/index-1.html | 18 +- docs/index-files/index-10.html | 45 +- docs/index-files/index-11.html | 20 +- docs/index-files/index-12.html | 29 +- docs/index-files/index-13.html | 40 +- docs/index-files/index-14.html | 134 ++++++ docs/index-files/index-15.html | 145 +++++++ docs/index-files/index-2.html | 28 +- docs/index-files/index-3.html | 12 +- docs/index-files/index-4.html | 18 +- docs/index-files/index-5.html | 34 +- docs/index-files/index-6.html | 34 +- docs/index-files/index-7.html | 30 +- docs/index-files/index-8.html | 24 +- docs/index-files/index-9.html | 41 +- docs/index.html | 2 +- docs/overview-frame.html | 4 +- docs/overview-summary.html | 10 +- docs/overview-tree.html | 10 +- docs/xyz/etztech/core/CoreUtils.html | 7 +- .../etztech/core/api/IMinecraftManager.html | 4 +- docs/xyz/etztech/core/api/package-frame.html | 4 +- .../xyz/etztech/core/api/package-summary.html | 4 +- docs/xyz/etztech/core/api/package-tree.html | 4 +- docs/xyz/etztech/core/db/DataSource.html | 6 +- docs/xyz/etztech/core/db/package-frame.html | 4 +- docs/xyz/etztech/core/db/package-summary.html | 8 +- docs/xyz/etztech/core/db/package-tree.html | 4 +- .../etztech/core/maven/MavenLibraries.html | 4 +- docs/xyz/etztech/core/maven/MavenLibrary.html | 4 +- docs/xyz/etztech/core/maven/MavenLoader.html | 6 +- docs/xyz/etztech/core/maven/MavenPlugin.html | 69 ++- .../xyz/etztech/core/maven/package-frame.html | 4 +- .../etztech/core/maven/package-summary.html | 4 +- docs/xyz/etztech/core/maven/package-tree.html | 4 +- docs/xyz/etztech/core/package-frame.html | 4 +- docs/xyz/etztech/core/package-summary.html | 17 +- docs/xyz/etztech/core/package-tree.html | 4 +- docs/xyz/etztech/core/web/CoreResponse.html | 10 +- .../etztech/core/web/CoreWeb.HttpMethod.html | 8 +- docs/xyz/etztech/core/web/CoreWeb.html | 8 +- .../xyz/etztech/core/web/Http.HttpMethod.html | 344 +++++++++++++++ docs/xyz/etztech/core/web/Http.Method.html | 344 +++++++++++++++ docs/xyz/etztech/core/web/Http.html | 402 +++++++++++++++++ docs/xyz/etztech/core/web/ICallback.html | 8 +- .../etztech/core/web/MultipartUtility.html | 21 +- docs/xyz/etztech/core/web/Response.html | 409 ++++++++++++++++++ docs/xyz/etztech/core/web/package-frame.html | 10 +- .../xyz/etztech/core/web/package-summary.html | 26 +- docs/xyz/etztech/core/web/package-tree.html | 10 +- pom.xml | 14 +- src/main/java/xyz/etztech/core/CoreUtils.java | 3 + .../xyz/etztech/core/db/package-info.java | 2 +- .../xyz/etztech/core/maven/MavenLoader.java | 2 +- .../xyz/etztech/core/maven/MavenPlugin.java | 12 + .../java/xyz/etztech/core/package-info.java | 4 + .../core/web/{CoreWeb.java => Http.java} | 25 +- .../etztech/core/web/MultipartUtility.java | 12 +- .../web/{CoreResponse.java => Response.java} | 10 +- 64 files changed, 2216 insertions(+), 345 deletions(-) create mode 100644 docs/index-files/index-14.html create mode 100644 docs/index-files/index-15.html create mode 100644 docs/xyz/etztech/core/web/Http.HttpMethod.html create mode 100644 docs/xyz/etztech/core/web/Http.Method.html create mode 100644 docs/xyz/etztech/core/web/Http.html create mode 100644 docs/xyz/etztech/core/web/Response.html create mode 100644 src/main/java/xyz/etztech/core/package-info.java rename src/main/java/xyz/etztech/core/web/{CoreWeb.java => Http.java} (87%) rename src/main/java/xyz/etztech/core/web/{CoreResponse.java => Response.java} (90%) diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html index 7656795..311b464 100644 --- a/docs/allclasses-frame.html +++ b/docs/allclasses-frame.html @@ -2,9 +2,9 @@ - + All Classes - + @@ -12,11 +12,10 @@

All Classes

diff --git a/docs/allclasses-noframe.html b/docs/allclasses-noframe.html index 65e08a0..5ca7ef0 100644 --- a/docs/allclasses-noframe.html +++ b/docs/allclasses-noframe.html @@ -2,9 +2,9 @@ - + All Classes - + @@ -12,11 +12,10 @@

All Classes

diff --git a/docs/constant-values.html b/docs/constant-values.html index d950058..705e743 100644 --- a/docs/constant-values.html +++ b/docs/constant-values.html @@ -2,9 +2,9 @@ - + Constant Field Values - + diff --git a/docs/deprecated-list.html b/docs/deprecated-list.html index fffa9c4..bda26c4 100644 --- a/docs/deprecated-list.html +++ b/docs/deprecated-list.html @@ -2,9 +2,9 @@ - + Deprecated List - + @@ -87,7 +87,7 @@ -xyz.etztech.core.web.CoreResponse.getMCMessage() +xyz.etztech.core.web.Response.getMCMessage() diff --git a/docs/help-doc.html b/docs/help-doc.html index 8aface7..f2dfc04 100644 --- a/docs/help-doc.html +++ b/docs/help-doc.html @@ -2,9 +2,9 @@ - + API Help - + diff --git a/docs/index-files/index-1.html b/docs/index-files/index-1.html index c519c8f..c782ffd 100644 --- a/docs/index-files/index-1.html +++ b/docs/index-files/index-1.html @@ -2,9 +2,9 @@ - + A-Index - + @@ -68,14 +68,14 @@ -
A C D F G H I L M O S V X  +
A C D E F G H I L M O R S V X 

A

addFilePart(String, File) - Method in class xyz.etztech.core.web.MultipartUtility
-
Adds a upload file section to the request
+
Adds an upload file section to the request
addFormField(String, String) - Method in class xyz.etztech.core.web.MultipartUtility
@@ -85,16 +85,16 @@
Adds a header field to the request.
-
asyncGet(Plugin, String, Map<String, String>) - Static method in class xyz.etztech.core.web.CoreWeb
+
asyncGet(Plugin, String, Map<String, String>) - Static method in class xyz.etztech.core.web.Http
 
-
asyncGetCallback(Plugin, String, Map<String, String>, ICallback) - Static method in class xyz.etztech.core.web.CoreWeb
+
asyncGetCallback(Plugin, String, Map<String, String>, ICallback) - Static method in class xyz.etztech.core.web.Http
 
-
asyncPost(Plugin, String, Map<String, String>) - Static method in class xyz.etztech.core.web.CoreWeb
+
asyncPost(Plugin, String, Map<String, String>) - Static method in class xyz.etztech.core.web.Http
 
-
asyncPostCallback(Plugin, String, Map<String, String>, ICallback) - Static method in class xyz.etztech.core.web.CoreWeb
+
asyncPostCallback(Plugin, String, Map<String, String>, ICallback) - Static method in class xyz.etztech.core.web.Http
 
-A C D F G H I L M O S V X 
+A C D E F G H I L M O R S V X 
diff --git a/docs/index-files/index-10.html b/docs/index-files/index-10.html index 7c55dd2..2c3bfb6 100644 --- a/docs/index-files/index-10.html +++ b/docs/index-files/index-10.html @@ -2,9 +2,9 @@ - -O-Index - + +M-Index + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D E F G H I L M O R S V X  + + +

V

+
+
valueOf(String) - Static method in enum xyz.etztech.core.web.Http.Method
+
+
Returns the enum constant of this type with the specified name.
+
+
values() - Static method in enum xyz.etztech.core.web.Http.Method
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
+A C D E F G H I L M O R S V X 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/index-files/index-15.html b/docs/index-files/index-15.html new file mode 100644 index 0000000..6421de3 --- /dev/null +++ b/docs/index-files/index-15.html @@ -0,0 +1,145 @@ + + + + + +X-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D E F G H I L M O R S V X  + + +

X

+
+
xyz.etztech.core - package xyz.etztech.core
+
+
PluginAPI Core for Plugins
+
+
xyz.etztech.core.api - package xyz.etztech.core.api
+
+
API classes for EtzTech plugins
+
+
xyz.etztech.core.db - package xyz.etztech.core.db
+
+
Database classes utilizing HikariCP and H2
+
+
xyz.etztech.core.maven - package xyz.etztech.core.maven
+
+
Maven annotations used to eliminate shaded plugins
+
+
xyz.etztech.core.web - package xyz.etztech.core.web
+
+
A core set of web utilities
+
+
+A C D E F G H I L M O R S V X 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/index-files/index-2.html b/docs/index-files/index-2.html index a7e39f5..fb85747 100644 --- a/docs/index-files/index-2.html +++ b/docs/index-files/index-2.html @@ -2,9 +2,9 @@ - + C-Index - + @@ -68,33 +68,19 @@
-
A C D F G H I L M O S V X  +
A C D E F G H I L M O R S V X 

C

-
CoreResponse - Class in xyz.etztech.core.web
-
-
A basic class to wrap a JSON response containing a simple status and message
-
-
CoreResponse(JsonArray) - Constructor for class xyz.etztech.core.web.CoreResponse
-
 
-
CoreResponse(JsonObject) - Constructor for class xyz.etztech.core.web.CoreResponse
-
 
-
CoreResponse(String) - Constructor for class xyz.etztech.core.web.CoreResponse
-
 
CoreUtils - Class in xyz.etztech.core
-
 
+
+
A core set of Plugin utilities
+
CoreUtils() - Constructor for class xyz.etztech.core.CoreUtils
 
-
CoreWeb - Class in xyz.etztech.core.web
-
 
-
CoreWeb() - Constructor for class xyz.etztech.core.web.CoreWeb
-
 
-
CoreWeb.HttpMethod - Enum in xyz.etztech.core.web
-
 
-A C D F G H I L M O S V X 
+A C D E F G H I L M O R S V X 
diff --git a/docs/index-files/index-3.html b/docs/index-files/index-3.html index 81fd2ce..e0fd175 100644 --- a/docs/index-files/index-3.html +++ b/docs/index-files/index-3.html @@ -2,9 +2,9 @@ - + D-Index - + @@ -68,7 +68,7 @@
-
A C D F G H I L M O S V X  +
A C D E F G H I L M O R S V X 

D

@@ -81,8 +81,12 @@
Create a data source for a plugin
+
disable() - Method in class xyz.etztech.core.maven.MavenPlugin
+
+
Allows a plugin to customize their onDisable method
+
-A C D F G H I L M O S V X 
+A C D E F G H I L M O R S V X 
diff --git a/docs/index-files/index-4.html b/docs/index-files/index-4.html index 4091d41..a9b255d 100644 --- a/docs/index-files/index-4.html +++ b/docs/index-files/index-4.html @@ -2,9 +2,9 @@ - -F-Index - + +E-Index + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ diff --git a/docs/overview-summary.html b/docs/overview-summary.html index 2214467..248dd29 100644 --- a/docs/overview-summary.html +++ b/docs/overview-summary.html @@ -2,9 +2,9 @@ - + Overview - + @@ -78,7 +78,9 @@ xyz.etztech.core -  + +
PluginAPI Core for Plugins
+ xyz.etztech.core.api @@ -89,7 +91,7 @@ xyz.etztech.core.db -
Database utilities utilizing HikariCP and H2
+
Database classes utilizing HikariCP and H2
diff --git a/docs/overview-tree.html b/docs/overview-tree.html index 07dd514..8ff8a95 100644 --- a/docs/overview-tree.html +++ b/docs/overview-tree.html @@ -2,9 +2,9 @@ - + Class Hierarchy - + @@ -84,10 +84,9 @@ @@ -118,7 +118,7 @@ diff --git a/docs/xyz/etztech/core/CoreUtils.html b/docs/xyz/etztech/core/CoreUtils.html index c093c6b..f7bb71c 100644 --- a/docs/xyz/etztech/core/CoreUtils.html +++ b/docs/xyz/etztech/core/CoreUtils.html @@ -2,9 +2,9 @@ - + CoreUtils - + @@ -110,6 +110,7 @@ var activeTableTab = "activeTableTab"; 
public class CoreUtils
 extends java.lang.Object
+
A core set of Plugin utilities
@@ -159,7 +160,7 @@ extends java.lang.Object

Methods inherited from class java.lang.Object

-equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait diff --git a/docs/xyz/etztech/core/api/IMinecraftManager.html b/docs/xyz/etztech/core/api/IMinecraftManager.html index 23b7725..afdfa35 100644 --- a/docs/xyz/etztech/core/api/IMinecraftManager.html +++ b/docs/xyz/etztech/core/api/IMinecraftManager.html @@ -2,9 +2,9 @@ - + IMinecraftManager - + diff --git a/docs/xyz/etztech/core/api/package-frame.html b/docs/xyz/etztech/core/api/package-frame.html index c59e58d..25f30d7 100644 --- a/docs/xyz/etztech/core/api/package-frame.html +++ b/docs/xyz/etztech/core/api/package-frame.html @@ -2,9 +2,9 @@ - + xyz.etztech.core.api - + diff --git a/docs/xyz/etztech/core/api/package-summary.html b/docs/xyz/etztech/core/api/package-summary.html index 4f9b8ea..39b938f 100644 --- a/docs/xyz/etztech/core/api/package-summary.html +++ b/docs/xyz/etztech/core/api/package-summary.html @@ -2,9 +2,9 @@ - + xyz.etztech.core.api - + diff --git a/docs/xyz/etztech/core/api/package-tree.html b/docs/xyz/etztech/core/api/package-tree.html index 2e63801..4983190 100644 --- a/docs/xyz/etztech/core/api/package-tree.html +++ b/docs/xyz/etztech/core/api/package-tree.html @@ -2,9 +2,9 @@ - + xyz.etztech.core.api Class Hierarchy - + diff --git a/docs/xyz/etztech/core/db/DataSource.html b/docs/xyz/etztech/core/db/DataSource.html index 8f26142..6d60f80 100644 --- a/docs/xyz/etztech/core/db/DataSource.html +++ b/docs/xyz/etztech/core/db/DataSource.html @@ -2,9 +2,9 @@ - + DataSource - + @@ -158,7 +158,7 @@ extends java.lang.Object

Methods inherited from class java.lang.Object

-equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait diff --git a/docs/xyz/etztech/core/db/package-frame.html b/docs/xyz/etztech/core/db/package-frame.html index aeb7854..14c0931 100644 --- a/docs/xyz/etztech/core/db/package-frame.html +++ b/docs/xyz/etztech/core/db/package-frame.html @@ -2,9 +2,9 @@ - + xyz.etztech.core.db - + diff --git a/docs/xyz/etztech/core/db/package-summary.html b/docs/xyz/etztech/core/db/package-summary.html index ca79b40..0c5a4af 100644 --- a/docs/xyz/etztech/core/db/package-summary.html +++ b/docs/xyz/etztech/core/db/package-summary.html @@ -2,9 +2,9 @@ - + xyz.etztech.core.db - + @@ -71,7 +71,7 @@

Package xyz.etztech.core.db

-
Database utilities utilizing HikariCP and H2
+
Database classes utilizing HikariCP and H2

See: Description

@@ -99,7 +99,7 @@

Package xyz.etztech.core.db Description

-
Database utilities utilizing HikariCP and H2
+
Database classes utilizing HikariCP and H2
diff --git a/docs/xyz/etztech/core/db/package-tree.html b/docs/xyz/etztech/core/db/package-tree.html index ff24842..6166874 100644 --- a/docs/xyz/etztech/core/db/package-tree.html +++ b/docs/xyz/etztech/core/db/package-tree.html @@ -2,9 +2,9 @@ - + xyz.etztech.core.db Class Hierarchy - + diff --git a/docs/xyz/etztech/core/maven/MavenLibraries.html b/docs/xyz/etztech/core/maven/MavenLibraries.html index e1e7e99..d6a71ad 100644 --- a/docs/xyz/etztech/core/maven/MavenLibraries.html +++ b/docs/xyz/etztech/core/maven/MavenLibraries.html @@ -2,9 +2,9 @@ - + MavenLibraries - + diff --git a/docs/xyz/etztech/core/maven/MavenLibrary.html b/docs/xyz/etztech/core/maven/MavenLibrary.html index fb9b6ad..668f301 100644 --- a/docs/xyz/etztech/core/maven/MavenLibrary.html +++ b/docs/xyz/etztech/core/maven/MavenLibrary.html @@ -2,9 +2,9 @@ - + MavenLibrary - + diff --git a/docs/xyz/etztech/core/maven/MavenLoader.html b/docs/xyz/etztech/core/maven/MavenLoader.html index 33e93cb..b94f47a 100644 --- a/docs/xyz/etztech/core/maven/MavenLoader.html +++ b/docs/xyz/etztech/core/maven/MavenLoader.html @@ -2,9 +2,9 @@ - + MavenLoader - + @@ -158,7 +158,7 @@ extends java.lang.Object

Methods inherited from class java.lang.Object

-equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait diff --git a/docs/xyz/etztech/core/maven/MavenPlugin.html b/docs/xyz/etztech/core/maven/MavenPlugin.html index d99eb75..fe4a1c3 100644 --- a/docs/xyz/etztech/core/maven/MavenPlugin.html +++ b/docs/xyz/etztech/core/maven/MavenPlugin.html @@ -2,9 +2,9 @@ - + MavenPlugin - + @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -161,14 +161,32 @@ extends org.bukkit.plugin.java.JavaPlugin Method and Description +protected void +disable() +
Allows a plugin to customize their onDisable method
+ + + +protected void +enable() +
Allows a plugin to customize their onEnable method
+ + + +protected void +load() +
Allows a plugin to customize their onLoad method
+ + + void onDisable()  - + void onEnable()  - + void onLoad()  @@ -178,7 +196,7 @@ extends org.bukkit.plugin.java.JavaPlugin

Methods inherited from class org.bukkit.plugin.java.JavaPlugin

-getCommand, getConfig, getDataFolder, getDefaultWorldGenerator, getDescription, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, isEnabled, isNaggable, onCommand, onTabComplete, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setNaggable, toString +getClassLoader, getCommand, getConfig, getDataFolder, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, getTextResource, isEnabled, isNaggable, onCommand, onTabComplete, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toString + @@ -225,6 +250,36 @@ extends org.bukkit.plugin.java.JavaPlugin

Method Detail

+ + + + + + + + + + + + diff --git a/docs/xyz/etztech/core/maven/package-frame.html b/docs/xyz/etztech/core/maven/package-frame.html index 2125b81..19163e7 100644 --- a/docs/xyz/etztech/core/maven/package-frame.html +++ b/docs/xyz/etztech/core/maven/package-frame.html @@ -2,9 +2,9 @@ - + xyz.etztech.core.maven - + diff --git a/docs/xyz/etztech/core/maven/package-summary.html b/docs/xyz/etztech/core/maven/package-summary.html index 8353a79..914b38b 100644 --- a/docs/xyz/etztech/core/maven/package-summary.html +++ b/docs/xyz/etztech/core/maven/package-summary.html @@ -2,9 +2,9 @@ - + xyz.etztech.core.maven - + diff --git a/docs/xyz/etztech/core/maven/package-tree.html b/docs/xyz/etztech/core/maven/package-tree.html index 01a400d..5db98fb 100644 --- a/docs/xyz/etztech/core/maven/package-tree.html +++ b/docs/xyz/etztech/core/maven/package-tree.html @@ -2,9 +2,9 @@ - + xyz.etztech.core.maven Class Hierarchy - + diff --git a/docs/xyz/etztech/core/package-frame.html b/docs/xyz/etztech/core/package-frame.html index 21e2491..6c0b88a 100644 --- a/docs/xyz/etztech/core/package-frame.html +++ b/docs/xyz/etztech/core/package-frame.html @@ -2,9 +2,9 @@ - + xyz.etztech.core - + diff --git a/docs/xyz/etztech/core/package-summary.html b/docs/xyz/etztech/core/package-summary.html index 4cfb9f3..2323334 100644 --- a/docs/xyz/etztech/core/package-summary.html +++ b/docs/xyz/etztech/core/package-summary.html @@ -2,9 +2,9 @@ - + xyz.etztech.core - + @@ -70,6 +70,10 @@

Package xyz.etztech.core

+
+
PluginAPI Core for Plugins
+
+

See: Description

    @@ -83,12 +87,19 @@ CoreUtils -  + +
    A core set of Plugin utilities
    +
+ + + +

Package xyz.etztech.core Description

+
PluginAPI Core for Plugins
diff --git a/docs/xyz/etztech/core/package-tree.html b/docs/xyz/etztech/core/package-tree.html index 66f3fc5..f17b6cd 100644 --- a/docs/xyz/etztech/core/package-tree.html +++ b/docs/xyz/etztech/core/package-tree.html @@ -2,9 +2,9 @@ - + xyz.etztech.core Class Hierarchy - + diff --git a/docs/xyz/etztech/core/web/CoreResponse.html b/docs/xyz/etztech/core/web/CoreResponse.html index a3eb033..73d58a1 100644 --- a/docs/xyz/etztech/core/web/CoreResponse.html +++ b/docs/xyz/etztech/core/web/CoreResponse.html @@ -2,9 +2,9 @@ - + CoreResponse - + @@ -99,7 +99,7 @@ var activeTableTab = "activeTableTab";
  • java.lang.Object
    • -
    • xyz.etztech.core.web.CoreResponse
      • +
    • xyz.etztech.core.web.Response
    • @@ -192,7 +192,7 @@ extends java.lang.Object

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait @@ -230,7 +230,7 @@ extends java.lang.Object 
    public CoreResponse(com.google.gson.JsonObject httpResponse)
    Parameters:
    -
    httpResponse - A JSON array e.g. a single result from one call
    +
    httpResponse - A JSON object e.g. a single result from one call
    diff --git a/docs/xyz/etztech/core/web/CoreWeb.HttpMethod.html b/docs/xyz/etztech/core/web/CoreWeb.HttpMethod.html index 966011a..1ce0a2a 100644 --- a/docs/xyz/etztech/core/web/CoreWeb.HttpMethod.html +++ b/docs/xyz/etztech/core/web/CoreWeb.HttpMethod.html @@ -2,9 +2,9 @@ - + CoreWeb.HttpMethod - + @@ -102,7 +102,7 @@ var activeTableTab = "activeTableTab";
  • java.lang.Enum<CoreWeb.HttpMethod>
    • -
    • xyz.etztech.core.web.CoreWeb.HttpMethod
      • +
    • xyz.etztech.core.web.Http.HttpMethod
    • @@ -180,7 +180,7 @@ the order they are declared.

    Methods inherited from class java.lang.Enum

    -compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf @@ -202,7 +202,7 @@ extends java.lang.Object

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait diff --git a/docs/xyz/etztech/core/web/Http.HttpMethod.html b/docs/xyz/etztech/core/web/Http.HttpMethod.html new file mode 100644 index 0000000..e104ac4 --- /dev/null +++ b/docs/xyz/etztech/core/web/Http.HttpMethod.html @@ -0,0 +1,344 @@ + + + + + +Http.HttpMethod + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    xyz.etztech.core.web
    +

    Enum Http.HttpMethod

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<Http.HttpMethod>
        • +
      • +
          +
        • xyz.etztech.core.web.Http.HttpMethod
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<Http.HttpMethod>
      +
      +
      +
      Enclosing class:
      +
      Http
      +
      +
      +
      +
      public static enum Http.HttpMethod
+extends java.lang.Enum<Http.HttpMethod>
      +
      Available HTTP methods to use with the raw HTTP method
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + +
        Enum Constants 
        Enum Constant and Description
        GET 
        POST 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethod and Description
        static Http.HttpMethodvalueOf(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static Http.HttpMethod[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static Http.HttpMethod[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (Http.HttpMethod c : Http.HttpMethod.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static Http.HttpMethod valueOf(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/docs/xyz/etztech/core/web/Http.Method.html b/docs/xyz/etztech/core/web/Http.Method.html new file mode 100644 index 0000000..3e7de2c --- /dev/null +++ b/docs/xyz/etztech/core/web/Http.Method.html @@ -0,0 +1,344 @@ + + + + + +Http.Method + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    xyz.etztech.core.web
    +

    Enum Http.Method

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<Http.Method>
        • +
      • +
          +
        • xyz.etztech.core.web.Http.Method
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<Http.Method>
      +
      +
      +
      Enclosing class:
      +
      Http
      +
      +
      +
      +
      public static enum Http.Method
+extends java.lang.Enum<Http.Method>
      +
      Available HTTP methods to use with the raw HTTP method
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + +
        Enum Constants 
        Enum Constant and Description
        GET 
        POST 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethod and Description
        static Http.MethodvalueOf(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static Http.Method[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static Http.Method[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (Http.Method c : Http.Method.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static Http.Method valueOf(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/docs/xyz/etztech/core/web/Http.html b/docs/xyz/etztech/core/web/Http.html new file mode 100644 index 0000000..01384a4 --- /dev/null +++ b/docs/xyz/etztech/core/web/Http.html @@ -0,0 +1,402 @@ + + + + + +Http + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    xyz.etztech.core.web
    +

    Class Http

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xyz.etztech.core.web.Http
        • +
      +
      • +
    +
    +
      +
    • +
      +
      +
      public class Http
+extends java.lang.Object
      +
      A static class used for HTTP calls within a plugin
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClass and Description
        static class Http.Method +
        Available HTTP methods to use with the raw HTTP method
        +
        +
        • +
      + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + +
        Constructors 
        Constructor and Description
        Http() 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethod and Description
        static voidasyncGet(org.bukkit.plugin.Plugin plugin, + java.lang.String url, + java.util.Map<java.lang.String,java.lang.String> data) 
        static voidasyncGetCallback(org.bukkit.plugin.Plugin plugin, + java.lang.String url, + java.util.Map<java.lang.String,java.lang.String> data, + ICallback callback) 
        static voidasyncPost(org.bukkit.plugin.Plugin plugin, + java.lang.String url, + java.util.Map<java.lang.String,java.lang.String> data) 
        static voidasyncPostCallback(org.bukkit.plugin.Plugin plugin, + java.lang.String url, + java.util.Map<java.lang.String,java.lang.String> data, + ICallback callback) 
        static java.lang.StringHTTP(java.lang.String endpoint, + Http.Method method, + java.util.Map<java.lang.String,java.lang.String> data) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Http

          +
          public Http()
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          asyncGet

          +
          public static void asyncGet(org.bukkit.plugin.Plugin plugin,
+                            java.lang.String url,
+                            java.util.Map<java.lang.String,java.lang.String> data)
          +
          +
          Parameters:
          +
          plugin - The calling plugin
          +
          url - The URL to call
          +
          data - A map of parameters
          +
          +
          • +
        + + + +
          +
        • +

          asyncGetCallback

          +
          public static void asyncGetCallback(org.bukkit.plugin.Plugin plugin,
+                                    java.lang.String url,
+                                    java.util.Map<java.lang.String,java.lang.String> data,
+                                    ICallback callback)
          +
          +
          Parameters:
          +
          plugin - The calling plugin
          +
          url - The URL to call
          +
          data - A map of parameters
          +
          callback - A class implementing an ICallBack to run upon completion
          +
          See Also:
          +
          ICallback
          +
          +
          • +
        + + + +
          +
        • +

          asyncPost

          +
          public static void asyncPost(org.bukkit.plugin.Plugin plugin,
+                             java.lang.String url,
+                             java.util.Map<java.lang.String,java.lang.String> data)
          +
          +
          Parameters:
          +
          plugin - The calling plugin
          +
          url - The URL to call
          +
          data - A map of parameters
          +
          +
          • +
        + + + +
          +
        • +

          asyncPostCallback

          +
          public static void asyncPostCallback(org.bukkit.plugin.Plugin plugin,
+                                     java.lang.String url,
+                                     java.util.Map<java.lang.String,java.lang.String> data,
+                                     ICallback callback)
          +
          +
          Parameters:
          +
          plugin - The calling plugin
          +
          url - The URL to call
          +
          data - A map of parameters
          +
          callback - A class implementing an ICallBack to run upon completion
          +
          See Also:
          +
          ICallback
          +
          +
          • +
        + + + +
          +
        • +

          HTTP

          +
          public static java.lang.String HTTP(java.lang.String endpoint,
+                                    Http.Method method,
+                                    java.util.Map<java.lang.String,java.lang.String> data)
+                             throws java.lang.Exception
          +
          +
          Throws:
          +
          java.lang.Exception
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/docs/xyz/etztech/core/web/ICallback.html b/docs/xyz/etztech/core/web/ICallback.html index 7b900c9..bc3491c 100644 --- a/docs/xyz/etztech/core/web/ICallback.html +++ b/docs/xyz/etztech/core/web/ICallback.html @@ -2,9 +2,9 @@ - + ICallback - + @@ -48,7 +48,7 @@ var activeTableTab = "activeTableTab";
    @@ -207,7 +208,7 @@ extends java.lang.Object 
    public MultipartUtility(java.lang.String requestURL,
                         java.lang.String charset)
                  throws java.io.IOException
    -
    This constructor initializes a new HTTP POST request with content type +
    This constructor initializes a new HTTP POST request where content type is set to multipart/form-data
    Parameters:
    @@ -251,10 +252,10 @@ extends java.lang.Object 
    public void addFilePart(java.lang.String fieldName,
                         java.io.File uploadFile)
                  throws java.io.IOException
    -
    Adds a upload file section to the request
    +
    Adds an upload file section to the request
    Parameters:
    -
    fieldName - name attribute in
    +
    fieldName - name attribute in HTML input element
    uploadFile - a File to be uploaded
    Throws:
    java.io.IOException - Could not access File
    @@ -322,7 +323,7 @@ extends java.lang.Object
    • Frames
      • diff --git a/docs/xyz/etztech/core/web/Response.html b/docs/xyz/etztech/core/web/Response.html new file mode 100644 index 0000000..ba82398 --- /dev/null +++ b/docs/xyz/etztech/core/web/Response.html @@ -0,0 +1,409 @@ + + + + + +Response + + + + + + + + +
      + + +
      Skip navigation links
      + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + +
      +
      xyz.etztech.core.web
      +

      Class Response

      +
      +
      +
        +
      • java.lang.Object
        • +
      • +
          +
        • xyz.etztech.core.web.Response
          • +
        +
        • +
      +
      +
        +
      • +
        +
        +
        public class Response
+extends java.lang.Object
        +
        A basic class to wrap a JSON response containing a simple status and message
        +
        • +
      +
      +
      +
        +
      • + +
          +
        • + + +

          Constructor Summary

          + + + + + + + + + + + + + + +
          Constructors 
          Constructor and Description
          Response(com.google.gson.JsonArray httpResponse) 
          Response(com.google.gson.JsonObject httpResponse) 
          Response(java.lang.String rawReponse) 
          +
          • +
        + +
          +
        • + + +

          Method Summary

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          All Methods Instance Methods Concrete Methods Deprecated Methods 
          Modifier and TypeMethod and Description
          com.google.gson.JsonObjectgetJson() 
          net.md_5.bungee.api.chat.TextComponentgetMCJSON() 
          java.lang.StringgetMCMessage() +
          Deprecated. 
          +
          java.lang.StringgetMessage() 
          java.lang.BooleangetStatus() 
          voidsetJson(com.google.gson.JsonObject json) 
          voidsetMessage(java.lang.String message) 
          voidsetStatus(java.lang.Boolean status) 
          +
            +
          • + + +

            Methods inherited from class java.lang.Object

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

          Constructor Detail

          + + + +
            +
          • +

            Response

            +
            public Response(com.google.gson.JsonArray httpResponse)
            +
            +
            Parameters:
            +
            httpResponse - A JSON array e.g. multiple results from one call
            +
            +
            • +
          + + + +
            +
          • +

            Response

            +
            public Response(com.google.gson.JsonObject httpResponse)
            +
            +
            Parameters:
            +
            httpResponse - A JSON object e.g. a single result from one call
            +
            +
            • +
          + + + +
            +
          • +

            Response

            +
            public Response(java.lang.String rawReponse)
            +
            +
            Parameters:
            +
            rawReponse - A raw JSON array in string format
            +
            +
            • +
          +
          • +
        + +
          +
        • + + +

          Method Detail

          + + + +
            +
          • +

            getJson

            +
            public com.google.gson.JsonObject getJson()
            +
            • +
          + + + +
            +
          • +

            setJson

            +
            public void setJson(com.google.gson.JsonObject json)
            +
            • +
          + + + +
            +
          • +

            getStatus

            +
            public java.lang.Boolean getStatus()
            +
            • +
          + + + +
            +
          • +

            setStatus

            +
            public void setStatus(java.lang.Boolean status)
            +
            • +
          + + + +
            +
          • +

            getMessage

            +
            public java.lang.String getMessage()
            +
            • +
          + + + +
            +
          • +

            setMessage

            +
            public void setMessage(java.lang.String message)
            +
            • +
          + + + +
            +
          • +

            getMCMessage

            +
            @Deprecated
+public java.lang.String getMCMessage()
            +
            Deprecated. 
            +
            +
            Returns:
            +
            A legacy Minecraft message using color codes
            +
            +
            • +
          + + + +
            +
          • +

            getMCJSON

            +
            public net.md_5.bungee.api.chat.TextComponent getMCJSON()
            +
            +
            Returns:
            +
            A Spigot JSON message
            +
            +
            • +
          +
          • +
        +
        • +
      +
      +
      + + +
      + + +
      Skip navigation links
      + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + + diff --git a/docs/xyz/etztech/core/web/package-frame.html b/docs/xyz/etztech/core/web/package-frame.html index 0aef842..ab3a080 100644 --- a/docs/xyz/etztech/core/web/package-frame.html +++ b/docs/xyz/etztech/core/web/package-frame.html @@ -2,9 +2,9 @@ - + xyz.etztech.core.web - + @@ -17,13 +17,13 @@

    Classes

    Enums

    diff --git a/docs/xyz/etztech/core/web/package-summary.html b/docs/xyz/etztech/core/web/package-summary.html index e074ad8..8d85894 100644 --- a/docs/xyz/etztech/core/web/package-summary.html +++ b/docs/xyz/etztech/core/web/package-summary.html @@ -2,9 +2,9 @@ - + xyz.etztech.core.web - + @@ -103,18 +103,22 @@ -CoreResponse +Http -
    A basic class to wrap a JSON response containing a simple status and message
    +
    A static class used for HTTP calls within a plugin
    -CoreWeb -  +MultipartUtility + +
    A non-Apache way to send form-data in a POST request
    + -MultipartUtility -  +Response + +
    A basic class to wrap a JSON response containing a simple status and message
    + @@ -128,8 +132,10 @@ -CoreWeb.HttpMethod -  +Http.Method + +
    Available HTTP methods to use with the raw HTTP method
    + diff --git a/docs/xyz/etztech/core/web/package-tree.html b/docs/xyz/etztech/core/web/package-tree.html index 8001359..3c0b2f0 100644 --- a/docs/xyz/etztech/core/web/package-tree.html +++ b/docs/xyz/etztech/core/web/package-tree.html @@ -2,9 +2,9 @@ - + xyz.etztech.core.web Class Hierarchy - + @@ -80,9 +80,9 @@ @@ -96,7 +96,7 @@
    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
    diff --git a/pom.xml b/pom.xml index 8963d64..101968e 100644 --- a/pom.xml +++ b/pom.xml @@ -5,8 +5,8 @@ 4.0.0 xyz.etztech - EtzCore - 1.0.5 + PluginAPI + 1.0.6 @@ -22,9 +22,9 @@ - org.spigotmc - spigot-api - 1.14.3-R0.1-SNAPSHOT + com.destroystokyo.paper + paper-api + 1.14.4-R0.1-SNAPSHOT provided @@ -41,8 +41,8 @@ - spigot-repo - https://hub.spigotmc.org/nexus/content/groups/public/ + papermc + https://papermc.io/repo/repository/maven-public/ mvn-repo diff --git a/src/main/java/xyz/etztech/core/CoreUtils.java b/src/main/java/xyz/etztech/core/CoreUtils.java index 29c00cb..2603f01 100644 --- a/src/main/java/xyz/etztech/core/CoreUtils.java +++ b/src/main/java/xyz/etztech/core/CoreUtils.java @@ -5,6 +5,9 @@ import org.bukkit.scheduler.BukkitScheduler; import java.util.logging.Logger; +/** + * A core set of Plugin utilities + */ public class CoreUtils { private static final BukkitScheduler schedule = Bukkit.getScheduler(); diff --git a/src/main/java/xyz/etztech/core/db/package-info.java b/src/main/java/xyz/etztech/core/db/package-info.java index 527691b..4c4e93b 100644 --- a/src/main/java/xyz/etztech/core/db/package-info.java +++ b/src/main/java/xyz/etztech/core/db/package-info.java @@ -1,4 +1,4 @@ /** - * Database utilities utilizing HikariCP and H2 + * Database classes utilizing HikariCP and H2 */ package xyz.etztech.core.db; \ No newline at end of file diff --git a/src/main/java/xyz/etztech/core/maven/MavenLoader.java b/src/main/java/xyz/etztech/core/maven/MavenLoader.java index bb66c07..08256eb 100644 --- a/src/main/java/xyz/etztech/core/maven/MavenLoader.java +++ b/src/main/java/xyz/etztech/core/maven/MavenLoader.java @@ -87,7 +87,7 @@ public final class MavenLoader { private static File getLibraryFolder() { File pluginsDir = plugin.getDataFolder().getParentFile(); - File libraryDir = new File(pluginsDir, "EtzCore/lib"); + File libraryDir = new File(pluginsDir, "PluginAPI/lib"); libraryDir.mkdirs(); return libraryDir; } diff --git a/src/main/java/xyz/etztech/core/maven/MavenPlugin.java b/src/main/java/xyz/etztech/core/maven/MavenPlugin.java index c81f1e3..7d8fd51 100644 --- a/src/main/java/xyz/etztech/core/maven/MavenPlugin.java +++ b/src/main/java/xyz/etztech/core/maven/MavenPlugin.java @@ -8,8 +8,20 @@ import org.bukkit.plugin.java.JavaPlugin; public class MavenPlugin extends JavaPlugin { // Allows plugins to still customize their load, enable, and disable methods + + /** + * Allows a plugin to customize their onLoad method + */ protected void load() {} + + /** + * Allows a plugin to customize their onEnable method + */ protected void enable() {} + + /** + * Allows a plugin to customize their onDisable method + */ protected void disable() {} @Override diff --git a/src/main/java/xyz/etztech/core/package-info.java b/src/main/java/xyz/etztech/core/package-info.java new file mode 100644 index 0000000..d836561 --- /dev/null +++ b/src/main/java/xyz/etztech/core/package-info.java @@ -0,0 +1,4 @@ +/** + * PluginAPI Core for Plugins + */ +package xyz.etztech.core; \ No newline at end of file diff --git a/src/main/java/xyz/etztech/core/web/CoreWeb.java b/src/main/java/xyz/etztech/core/web/Http.java similarity index 87% rename from src/main/java/xyz/etztech/core/web/CoreWeb.java rename to src/main/java/xyz/etztech/core/web/Http.java index c3da8ee..8a21b9a 100644 --- a/src/main/java/xyz/etztech/core/web/CoreWeb.java +++ b/src/main/java/xyz/etztech/core/web/Http.java @@ -1,6 +1,5 @@ package xyz.etztech.core.web; -import org.apache.commons.lang.StringUtils; import org.bukkit.Bukkit; import org.bukkit.plugin.Plugin; import org.bukkit.scheduler.BukkitScheduler; @@ -8,13 +7,14 @@ import org.bukkit.scheduler.BukkitScheduler; import java.io.*; import java.net.HttpURLConnection; import java.net.URL; -import java.net.URLConnection; import java.net.URLEncoder; -import java.nio.charset.StandardCharsets; import java.util.*; import java.util.logging.Logger; -public class CoreWeb { +/** + * A static class used for HTTP calls within a plugin + */ +public class Http { private static BukkitScheduler schedule = null; private static final Logger logger = Logger.getLogger("Minecraft"); @@ -35,7 +35,7 @@ public class CoreWeb { public static void asyncGet(final Plugin plugin, final String url, final Map data) { schedule.runTaskAsynchronously(plugin, () -> { try { - HTTP(url, HttpMethod.GET, data); + HTTP(url, Method.GET, data); } catch (Exception ex) { logger.warning("GET request failed. (" + url + ")"); } @@ -52,7 +52,7 @@ public class CoreWeb { public static void asyncGetCallback(final Plugin plugin, final String url, final Map data, final ICallback callback) { schedule.runTaskAsynchronously(plugin, () -> { try { - String result = HTTP(url, HttpMethod.GET, data); + String result = HTTP(url, Method.GET, data); callback.invoke(result); } catch (Exception ex) { logger.warning("GET request failed. (" + url + ")"); @@ -68,7 +68,7 @@ public class CoreWeb { public static void asyncPost(final Plugin plugin, final String url, final Map data) { schedule.runTaskAsynchronously(plugin, () -> { try { - HTTP(url, HttpMethod.POST, data); + HTTP(url, Method.POST, data); } catch (Exception ex) { logger.warning("POST request failed. (" + url + ")"); } @@ -85,7 +85,7 @@ public class CoreWeb { public static void asyncPostCallback(final Plugin plugin, final String url, final Map data, final ICallback callback) { schedule.runTaskAsynchronously(plugin, () -> { try { - String result = HTTP(url, HttpMethod.POST, data); + String result = HTTP(url, Method.POST, data); callback.invoke(result); } catch (Exception ex) { logger.warning("POST request failed. (" + url + ")"); @@ -93,13 +93,16 @@ public class CoreWeb { }); } - public enum HttpMethod { + /** + * Available HTTP methods to use with the raw HTTP method + */ + public enum Method { GET, POST } - public static String HTTP(String endpoint, HttpMethod method, Map data) throws Exception { - if (method == HttpMethod.POST) { + public static String HTTP(String endpoint, Method method, Map data) throws Exception { + if (method == Method.POST) { MultipartUtility request = new MultipartUtility(endpoint, "utf-8"); for (String key : data.keySet()) { request.addFormField(key, data.get(key)); diff --git a/src/main/java/xyz/etztech/core/web/MultipartUtility.java b/src/main/java/xyz/etztech/core/web/MultipartUtility.java index c005fb8..7da290a 100644 --- a/src/main/java/xyz/etztech/core/web/MultipartUtility.java +++ b/src/main/java/xyz/etztech/core/web/MultipartUtility.java @@ -15,7 +15,9 @@ import java.net.URLConnection; import java.util.ArrayList; import java.util.List; - +/** + * A non-Apache way to send form-data in a POST request + */ public class MultipartUtility { private final String boundary; private static final String LINE_FEED = "\r\n"; @@ -25,7 +27,7 @@ public class MultipartUtility { private PrintWriter writer; /** - * This constructor initializes a new HTTP POST request with content type + * This constructor initializes a new HTTP POST request where content type * is set to multipart/form-data * @param requestURL The URL to post to * @param charset The character set to use @@ -45,7 +47,7 @@ public class MultipartUtility { httpConn.setDoInput(true); httpConn.setRequestProperty("Content-Type", "multipart/form-data; boundary=" + boundary); - httpConn.setRequestProperty("User-Agent", "EtzCore Agent"); + httpConn.setRequestProperty("User-Agent", "PluginAPI Agent"); outputStream = httpConn.getOutputStream(); writer = new PrintWriter(new OutputStreamWriter(outputStream, charset), true); @@ -68,8 +70,8 @@ public class MultipartUtility { } /** - * Adds a upload file section to the request - * @param fieldName name attribute in + * Adds an upload file section to the request + * @param fieldName name attribute in HTML input element * @param uploadFile a File to be uploaded * @throws IOException Could not access File */ diff --git a/src/main/java/xyz/etztech/core/web/CoreResponse.java b/src/main/java/xyz/etztech/core/web/Response.java similarity index 90% rename from src/main/java/xyz/etztech/core/web/CoreResponse.java rename to src/main/java/xyz/etztech/core/web/Response.java index b99bb5d..2fff89e 100644 --- a/src/main/java/xyz/etztech/core/web/CoreResponse.java +++ b/src/main/java/xyz/etztech/core/web/Response.java @@ -12,7 +12,7 @@ import java.util.logging.Logger; /** * A basic class to wrap a JSON response containing a simple status and message */ -public class CoreResponse { +public class Response { private JsonObject json; private Boolean status; @@ -23,16 +23,16 @@ public class CoreResponse { /** * @param httpResponse A JSON array e.g. multiple results from one call */ - public CoreResponse(JsonArray httpResponse) { + public Response(JsonArray httpResponse) { json = httpResponse.get(0).getAsJsonObject(); setStatus(json.get("status").getAsBoolean()); setMessage(json.get("message").getAsString()); } /** - * @param httpResponse A JSON array e.g. a single result from one call + * @param httpResponse A JSON object e.g. a single result from one call */ - public CoreResponse(JsonObject httpResponse) { + public Response(JsonObject httpResponse) { json = httpResponse; setStatus(httpResponse.get("status").getAsBoolean()); setMessage(httpResponse.get("message").getAsString()); @@ -41,7 +41,7 @@ public class CoreResponse { /** * @param rawReponse A raw JSON array in string format */ - public CoreResponse(String rawReponse) { + public Response(String rawReponse) { JsonParser parser = new JsonParser(); try { json = (JsonObject) parser.parse(rawReponse);