BanServiceMBean documentation

Bean Description > List of operations > Operations declaration

Bean Description

Description : Ban service

Type : net.sbbi.jafs.services.BanService

Domain : services

List of operations

ban, getBannedIps, getBlackListedIps, isBannedIP, registredServers, unBan, unBanOnReason

Operations declaration

registredServers

Description	Return the available servers codes registred in this service

Return type

Impact	INFO

getBannedIps

Description

List all the banned ip on a given server

Return type

net.sbbi.jafs.logs.BanLogEntry[]

Impact

INFO

Parameters

serverCode

type: java.lang.String

The server to list

getBlackListedIps

Description

List all the blacklist ip on a given server

Return type

net.sbbi.jafs.ipblocklists.BannedIPRangeEntry[]

Impact

INFO

Parameters

serverCode

type: java.lang.String

The server to list

ban

Description

Ban an IP address for on a given server

Return type

Impact

ACTION

Parameters

serverCode	type: java.lang.String	The server code where this ip will be banned
ipAddress	type: java.lang.String	The IP address to ban
reason	type: java.lang.String	The reason for which the client is banned

unBanOnReason

Description

Unban IP addresses banned for a given reason, return the number of unbanned IP

Return type

java.lang.Integer

Impact

ACTION

Parameters

serverCode	type: java.lang.String	The server code where this ip will be unbanned
reason	type: java.lang.String	The reason to unban the IP

unBan

Description

Unban an IP address for on a given server

Return type

Impact

ACTION

Parameters

serverCode	type: java.lang.String	The server code where this ip will be unbanned
ipAddress	type: java.lang.String	The IP address to unban

isBannedIP

Description

Tells if the given IP is banned on a server

Return type

Impact

ACTION

Parameters

serverCode	type: java.lang.String	The server code where this ip should be banned
ipAddress	type: java.lang.String	The IP address