ViaGatewayUtils (ApiHelper 1.5.0 API)

java.lang.Object
- gateway.api.ViaGatewayUtils

直接已知子类:

ViaGatewayUtlis
```
public abstract class ViaGatewayUtils
extends Object
```
通过网关的工具类

作者:

neeker

字段概要

字段
限定符和类型字段和说明

private static org.apache.commons.logging.Log Log

字段
限定符和类型	字段和说明
`private static org.apache.commons.logging.Log`	`Log`

构造器概要

构造器
构造器和说明

ViaGatewayUtils()

构造器
构造器和说明
`ViaGatewayUtils()`

方法概要

所有方法静态方法具体方法已过时的方法
限定符和类型	方法和说明
`static void`	`copyRequestChainForHttpClient(org.apache.http.HttpMessage http_msg)` 为httpclient复制调用链参数，验证模式是后台接口调用其它后台接口时使用
`static void`	`copyRequestChainForHttpClient(okhttp3.Request.Builder http_msg)`
`static void`	`firstRequestChainForHttpClient(org.apache.http.HttpMessage http_msg)` 为httpclient设置调用链入口参数，验证模式是前端接口调用其它接口时使用
`static void`	`firstRequestChainForHttpClient(okhttp3.Request.Builder http_msg)`
`static String`	`getApiIdViaGateway()` 获取当前API在服务端注册的ID
`static String`	`getApiIdViaGateway(javax.servlet.http.HttpServletRequest request)` 获取当前API在服务端注册的ID
`static String`	`getClientRealIp()` 获取客户端真实IP
`static String`	`getClientRealIp(javax.servlet.http.HttpServletRequest request)`
`static String`	`getClientUserAgent()` 获取用户浏览器UserAgent
`static String`	`getClientUserAgent(javax.servlet.http.HttpServletRequest request)`
`static String`	`getGatewayHost()` 获取网关主机名
`static String`	`getGatewayHost(javax.servlet.http.HttpServletRequest request)`
`static String`	`getGatewayId()` 获取网关ID
`static String`	`getGatewayId(javax.servlet.http.HttpServletRequest request)` 获取网关ID
`static int`	`getGatewayPort()` 获取网关端口
`static int`	`getGatewayPort(javax.servlet.http.HttpServletRequest request)` 获取网关端口
`static String`	`getGatewayProto()` 获取协议头
`static String`	`getGatewayProto(javax.servlet.http.HttpServletRequest request)` 获取协议头
`static javax.servlet.http.HttpServletRequest`	`getHttpServletRequest()` 获得当前的Servlet请求对象
`static javax.servlet.http.HttpServletRequest`	`GetHttpServletRequest()` 已过时。
`static String`	`getPublishURLViaGateway(javax.servlet.http.HttpServletRequest request, String target_url)` 获得通过网关的外部URL
`static String`	`getPublishURLViaGateway(String target_url)`
`static String`	`getReqeustRoot()`
`static String`	`getReqeustRoot(javax.servlet.http.HttpServletRequest request)` 获得请求根地址
`static String[]`	`getRequestAclGroups()` 已过时。
`static String[]`	`getRequestAclGroups(javax.servlet.http.HttpServletRequest request)` 已过时。
`static String`	`getRequestAppIdViaGateway()` 获取请求应用ID
`static String`	`getRequestAppIdViaGateway(javax.servlet.http.HttpServletRequest request)` 获取请求应用ID
`static String`	`getRequestDisplayNameViaGateway()`
`static String`	`getRequestDisplayNameViaGateway(javax.servlet.http.HttpServletRequest request)`
`static String`	`getRequestIdViaGateway()` 获取网关发过来的请求ID
`static String`	`getRequestIdViaGateway(javax.servlet.http.HttpServletRequest request)` 获取网关发过来的请求ID
`static String`	`getRequestPageId()` 获得请求页面ID
`static String`	`getRequestRootViaGateway()` 获得通过网关的请求根
`static String`	`getRequestRootViaGateway(javax.servlet.http.HttpServletRequest request)`
`static String`	`getRequestURIViaGateway()` 获取请求上下文URI（不含主机名与端口信息）
`static String`	`getRequestURIViaGateway(javax.servlet.http.HttpServletRequest request)` 获取请求上下文URI（不含主机名与端口信息）
`static String`	`getRequestURLViaGateway()` 获取请求URL（完整路径）
`static String`	`getRequestURLViaGateway(javax.servlet.http.HttpServletRequest request)` 获取请求URL（完整路径）
`static String`	`getRequestUserIdViaGateway()` 获取请求用户ID
`static String`	`getRequestUserIdViaGateway(javax.servlet.http.HttpServletRequest request)` 获取请求用户ID
`static String`	`getRequestUsernameViaGateway()` 获取请求用户名
`static String`	`getRequestUsernameViaGateway(javax.servlet.http.HttpServletRequest request)`
`static String`	`getTraceChainIdViaGateway()` 获取调用链
`static String`	`getTraceChainIdViaGateway(javax.servlet.http.HttpServletRequest request)` 获取调用链
`static String`	`getTraceParentIdViaGateway()` 获取调用链上层ID
`static String`	`getTraceParentIdViaGateway(javax.servlet.http.HttpServletRequest request)` 获取调用链上层ID
`static void`	`initRequestChainForHttpClient(org.apache.http.HttpMessage http_msg)`
`static void`	`initRequestChainForHttpClient(okhttp3.Request.Builder http_msg)`
`static boolean`	`isAppRequestViaGateway()` 判断是否应用通过网关访问
`static boolean`	`isAppRequestViaGateway(javax.servlet.http.HttpServletRequest request)` 判断是否应用通过网关访问
`static boolean`	`isRequestViaGateway()` 判断是否从网关过来的
`static boolean`	`isRequestViaGateway(javax.servlet.http.HttpServletRequest request)`
`static boolean`	`isRequestViaWeb()` 判断是否来自WEB请求
`static boolean`	`isUserRequestViaGateway()` 判断是否通过用户前端访问
`static boolean`	`isUserRequestViaGateway(javax.servlet.http.HttpServletRequest request)` 判断是否通过用户前端访问
`static Properties`	`parseQueryStringParameters(String data)` 分析QueryString格式的字符串为Properties对象，不进行UrlDecode
`static Properties`	`parseQueryStringParameters(String data, boolean val_url_decode)` 分析QueryString格式的字符串为Properties对象
`static Map<String,Object>`	`requestParametersToMap(javax.servlet.http.HttpServletRequest request)`
`static Map<String,Object>`	`requestParametersToMap(javax.servlet.http.HttpServletRequest request, Set<String> exclude_names)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

Log

private static final org.apache.commons.logging.Log Log

构造器详细资料
- ViaGatewayUtils
```
public ViaGatewayUtils()
```

方法详细资料

getClientRealIp
```
public static String getClientRealIp()
```
获取客户端真实IP

返回:

getClientRealIp

public static String getClientRealIp(javax.servlet.http.HttpServletRequest request)

getClientUserAgent
```
public static String getClientUserAgent()
```
获取用户浏览器UserAgent

返回:

getClientUserAgent

public static String getClientUserAgent(javax.servlet.http.HttpServletRequest request)

parseQueryStringParameters
```
public static Properties parseQueryStringParameters(String data)
```
分析QueryString格式的字符串为Properties对象，不进行UrlDecode

参数:

data -

返回:

GetHttpServletRequest

@Deprecated
public static javax.servlet.http.HttpServletRequest GetHttpServletRequest()

已过时。

getRequestRootViaGateway
```
public static String getRequestRootViaGateway()
```
获得通过网关的请求根

返回:

getRequestRootViaGateway

public static String getRequestRootViaGateway(javax.servlet.http.HttpServletRequest request)

getGatewayProto
```
public static String getGatewayProto()
```
获取协议头

参数:

request -

返回:

getGatewayProto

public static String getGatewayProto(javax.servlet.http.HttpServletRequest request)

获取协议头

参数:: request -
返回:

getRequestURIViaGateway
```
public static String getRequestURIViaGateway()
```
获取请求上下文URI（不含主机名与端口信息）

返回:

getRequestURIViaGateway

public static String getRequestURIViaGateway(javax.servlet.http.HttpServletRequest request)

获取请求上下文URI（不含主机名与端口信息）

返回:

getRequestURLViaGateway
```
public static String getRequestURLViaGateway()
```
获取请求URL（完整路径）

返回:

getRequestURLViaGateway

public static String getRequestURLViaGateway(javax.servlet.http.HttpServletRequest request)

获取请求URL（完整路径）

返回:

getGatewayPort
```
public static int getGatewayPort()
```
获取网关端口

返回:

getGatewayPort

public static int getGatewayPort(javax.servlet.http.HttpServletRequest request)

获取网关端口

返回:

parseQueryStringParameters

public static Properties parseQueryStringParameters(String data,
                                                    boolean val_url_decode)

分析QueryString格式的字符串为Properties对象

参数:: data -; val_url_decode -
返回:

getRequestPageId

public static String getRequestPageId()

获得请求页面ID

返回:

getHttpServletRequest

public static javax.servlet.http.HttpServletRequest getHttpServletRequest()

获得当前的Servlet请求对象

返回:

isRequestViaWeb
```
public static boolean isRequestViaWeb()
```
判断是否来自WEB请求

返回:

isRequestViaGateway
```
public static boolean isRequestViaGateway()
```
判断是否从网关过来的

返回:

isRequestViaGateway

public static boolean isRequestViaGateway(javax.servlet.http.HttpServletRequest request)

getRequestIdViaGateway
```
public static String getRequestIdViaGateway()
```
获取网关发过来的请求ID

返回:

getRequestIdViaGateway

public static String getRequestIdViaGateway(javax.servlet.http.HttpServletRequest request)

获取网关发过来的请求ID

返回:

getTraceParentIdViaGateway
```
public static String getTraceParentIdViaGateway()
```
获取调用链上层ID

返回:

getTraceParentIdViaGateway

public static String getTraceParentIdViaGateway(javax.servlet.http.HttpServletRequest request)

获取调用链上层ID

返回:

getTraceChainIdViaGateway

public static String getTraceChainIdViaGateway()

获取调用链

返回:

getTraceChainIdViaGateway

public static String getTraceChainIdViaGateway(javax.servlet.http.HttpServletRequest request)

获取调用链

返回:

firstRequestChainForHttpClient
```
public static void firstRequestChainForHttpClient(org.apache.http.HttpMessage http_msg)
```
为httpclient设置调用链入口参数，验证模式是前端接口调用其它接口时使用

参数:

http_msg -

firstRequestChainForHttpClient

public static void firstRequestChainForHttpClient(okhttp3.Request.Builder http_msg)

copyRequestChainForHttpClient
```
public static void copyRequestChainForHttpClient(org.apache.http.HttpMessage http_msg)
```
为httpclient复制调用链参数，验证模式是后台接口调用其它后台接口时使用

参数:

http_msg -

initRequestChainForHttpClient

public static void initRequestChainForHttpClient(org.apache.http.HttpMessage http_msg)

initRequestChainForHttpClient

public static void initRequestChainForHttpClient(okhttp3.Request.Builder http_msg)

copyRequestChainForHttpClient

public static void copyRequestChainForHttpClient(okhttp3.Request.Builder http_msg)

getApiIdViaGateway
```
public static String getApiIdViaGateway()
```
获取当前API在服务端注册的ID

返回:

getApiIdViaGateway

public static String getApiIdViaGateway(javax.servlet.http.HttpServletRequest request)

获取当前API在服务端注册的ID

返回:

getGatewayHost
```
public static String getGatewayHost()
```
获取网关主机名

返回:

getGatewayHost

public static String getGatewayHost(javax.servlet.http.HttpServletRequest request)

getGatewayId
```
public static String getGatewayId()
```
获取网关ID

返回:

getGatewayId

public static String getGatewayId(javax.servlet.http.HttpServletRequest request)

获取网关ID

返回:

getRequestAppIdViaGateway

public static String getRequestAppIdViaGateway()

获取请求应用ID

返回:

getRequestAppIdViaGateway

public static String getRequestAppIdViaGateway(javax.servlet.http.HttpServletRequest request)

获取请求应用ID

返回:

isAppRequestViaGateway
```
public static boolean isAppRequestViaGateway()
```
判断是否应用通过网关访问

返回:

isAppRequestViaGateway

public static boolean isAppRequestViaGateway(javax.servlet.http.HttpServletRequest request)

判断是否应用通过网关访问

返回:

isUserRequestViaGateway
```
public static boolean isUserRequestViaGateway()
```
判断是否通过用户前端访问

返回:

isUserRequestViaGateway

public static boolean isUserRequestViaGateway(javax.servlet.http.HttpServletRequest request)

判断是否通过用户前端访问

返回:

getRequestUserIdViaGateway

public static String getRequestUserIdViaGateway()

获取请求用户ID

返回:

getRequestUserIdViaGateway

public static String getRequestUserIdViaGateway(javax.servlet.http.HttpServletRequest request)

获取请求用户ID

返回:

getRequestUsernameViaGateway

public static String getRequestUsernameViaGateway()

获取请求用户名

返回:

getRequestUsernameViaGateway

public static String getRequestUsernameViaGateway(javax.servlet.http.HttpServletRequest request)

getRequestDisplayNameViaGateway

public static String getRequestDisplayNameViaGateway(javax.servlet.http.HttpServletRequest request)

getRequestDisplayNameViaGateway

public static String getRequestDisplayNameViaGateway()

getRequestAclGroups

@Deprecated
public static String[] getRequestAclGroups()

已过时。

获得ACL分组代码

返回:

getRequestAclGroups

@Deprecated
public static String[] getRequestAclGroups(javax.servlet.http.HttpServletRequest request)

已过时。

获得ACL分组代码

返回:

getReqeustRoot

public static String getReqeustRoot(javax.servlet.http.HttpServletRequest request)

获得请求根地址

参数:: request -
返回:

getReqeustRoot
```
public static String getReqeustRoot()
```

getPublishURLViaGateway

public static String getPublishURLViaGateway(String target_url)

getPublishURLViaGateway

public static String getPublishURLViaGateway(javax.servlet.http.HttpServletRequest request,
                                             String target_url)

获得通过网关的外部URL

参数:: request -; target_url -
返回:

requestParametersToMap

public static Map<String,Object> requestParametersToMap(javax.servlet.http.HttpServletRequest request)

requestParametersToMap

public static Map<String,Object> requestParametersToMap(javax.servlet.http.HttpServletRequest request,
                                                        Set<String> exclude_names)

类 ViaGatewayUtils

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

Log

构造器详细资料

ViaGatewayUtils

方法详细资料

getClientRealIp

getClientRealIp

getClientUserAgent

getClientUserAgent

parseQueryStringParameters

GetHttpServletRequest

getRequestRootViaGateway

getRequestRootViaGateway

getGatewayProto

getGatewayProto

getRequestURIViaGateway

getRequestURIViaGateway

getRequestURLViaGateway

getRequestURLViaGateway

getGatewayPort

getGatewayPort

parseQueryStringParameters

getRequestPageId

getHttpServletRequest

isRequestViaWeb

isRequestViaGateway

isRequestViaGateway

getRequestIdViaGateway

getRequestIdViaGateway

getTraceParentIdViaGateway

getTraceParentIdViaGateway

getTraceChainIdViaGateway

getTraceChainIdViaGateway

firstRequestChainForHttpClient

firstRequestChainForHttpClient

copyRequestChainForHttpClient

initRequestChainForHttpClient

initRequestChainForHttpClient

copyRequestChainForHttpClient

getApiIdViaGateway

getApiIdViaGateway

getGatewayHost

getGatewayHost

getGatewayId

getGatewayId

getRequestAppIdViaGateway

getRequestAppIdViaGateway

isAppRequestViaGateway

isAppRequestViaGateway

isUserRequestViaGateway

isUserRequestViaGateway

getRequestUserIdViaGateway

getRequestUserIdViaGateway

getRequestUsernameViaGateway

getRequestUsernameViaGateway

getRequestDisplayNameViaGateway

getRequestDisplayNameViaGateway

getRequestAclGroups

getRequestAclGroups

getReqeustRoot

getReqeustRoot

getPublishURLViaGateway

getPublishURLViaGateway

requestParametersToMap

requestParametersToMap