Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

webtool(3erl) [linux man page]

webtool(3erl)						     Erlang Module Definition						     webtool(3erl)

NAME

       webtool - WebTool is a tool used to simplify the implementation of web based tools with Erlang/OTP.

DESCRIPTION

       WebTool makes it easy to use web based tools with Erlang/OTP. WebTool configures and starts the webserver httpd.

EXPORTS

       start()-> {ok,Pid}| {stop,Reason}

	      Start  WebTool with default data, i.e. port 8888, ip-number 127.0.0.1, and server-name localhost . If port 8888 is in use, port 8889
	      is tried instead. If 8889 is also in use, 8890 is tried and so on. Max number of ports tried is 256.

	      The mime.types file and WebTool's own HTML files are assumed to be in the directory webtool-<vsn>/priv/root/conf .

       start(Path,Data)->{ok,Pid}|{stop,Reason}

	      Types  Path = string() | standard_path
		     Data = [Port,Address,Name] | PortNumber | standard_data
		     Port = {port,PortNumber}
		     Address = {bind_address,IpNumber}
		     Name = {server_name,ServerName}
		     PortNumber = integer()
		     IpNumber = tuple(), e.g. {127,0,0,1}
		     ServerName = string()
		     Pid = pid()

	      Use this function to start WebTool if the default port, ip-number,servername or path can not be used.

	      Path is the directory where the mime.types file and WebTool's own HTML files are located. By default this  is  webtool-<vsn>/priv  ,
	      and in most cases there is no need to change this. If Path is set to standard_path the default will be used.

	      If Data is set to PortNumber , the default data will be used for ip-number ( 127.0.0.1 ) and server name ( localhost ).

       stop()->void

	      Stop WebTool and the tools started by WebTool.

       debug_app(Module)->void

	      Types  Module = atom()

	      Debug a WebTool application by tracing all functions in the given module which are called from WebTool.

       stop_debug()->void

	      Stop the tracing started by debug_app/1 , and format the trace log.

CALLBACK FUNCTIONS

       The  following  callback  function must be implemented by each web based tool that will be used via WebTool. When started, WebTool searches
       the Erlang code path for *.tool files to locate all web based tools and their callback functions. See the WebTool  User's  Guide  for  more
       information about the *.tool files.

EXPORTS

       Module:Func(Data)-> {Name,WebData}|error

	      Types  Data = term()
		     Name = atom()
		     WebData = [WebOptions]
		     WebOptions = LinkData | Alias | Start
		     LinkData = {web_data,{ToolName,Url}}
		     Alias = {alias,{VirtualPath,RealPath}} | {alias,{erl_alias,Path,[Modules]}
		     Start = {start,StartData}
		     ToolName = Url = VirtualPath = RealPath = Path = string()
		     Modules = atom()
		     StartData = AppData | ChildSpec | Func
		     AppData = {app,AppName}
		     ChildSpec = {child,child_spec()}
		     See the Reference Manual for the module supervisor in the STDLIB application for details about child_spec().
		     Func = {func,{StartMod,StartFunc,StartArg}, {StopMod,StopFunc,StopArg}}
		     AppName = StartMod = StartFunc = StopMod = StopFunc =atom()
		     StartArg = StopArg = [term()]

	      This is the configuration function ( config_func ) which must be stated in the *.tool file.

	      The  function  is  called  by  WebTool  at  startup to retrieve the data needed to start and configure the tool. LinkData is used by
	      WebTool to create the link to the tool. Alias is used to create the aliases needed by the webserver. Start is used to start and stop
	      the tool.

SEE ALSO

       start_webtool(1) , WebTool User's Guide

Ericsson AB							   webtool 0.8.7						     webtool(3erl)

Check Out this Related Man Page

mod_security(3erl)					     Erlang Module Definition						mod_security(3erl)

NAME

       mod_security - Security Audit and Trailing Functionality

DESCRIPTION

       Security Audit and Trailing Functionality

EXPORTS

       list_auth_users(Port) -> Users | []
       list_auth_users(Address, Port) -> Users | []
       list_auth_users(Port, Dir) -> Users | []
       list_auth_users(Address, Port, Dir) -> Users | []

	      Types  Port = integer()
		     Address = {A,B,C,D} | string() | undefined
		     Dir = string()
		     Users = list() = [string()]

	      list_auth_users/1  ,  list_auth_users/2  and list_auth_users/3 returns a list of users that are currently authenticated. Authentica-
	      tions are stored for SecurityAuthTimeout seconds, and are then discarded.

       list_blocked_users(Port) -> Users | []
       list_blocked_users(Address, Port) -> Users | []
       list_blocked_users(Port, Dir) -> Users | []
       list_blocked_users(Address, Port, Dir) -> Users | []

	      Types  Port = integer()
		     Address = {A,B,C,D} | string() | undefined
		     Dir = string()
		     Users = list() = [string()]

	      list_blocked_users/1 , list_blocked_users/2 and list_blocked_users/3 returns a list of users that are currently blocked from access.

       block_user(User, Port, Dir, Seconds) -> true | {error, Reason}
       block_user(User, Address, Port, Dir, Seconds) -> true | {error, Reason}

	      Types  User = string()
		     Port = integer()
		     Address = {A,B,C,D} | string() | undefined
		     Dir = string()
		     Seconds = integer() | infinity
		     Reason = no_such_directory

	      block_user/4 and block_user/5 blocks the user User from the directory Dir for a specified amount of time.

       unblock_user(User, Port) -> true | {error, Reason}
       unblock_user(User, Address, Port) -> true | {error, Reason}
       unblock_user(User, Port, Dir) -> true | {error, Reason}
       unblock_user(User, Address, Port, Dir) -> true | {error, Reason}

	      Types  User = string()
		     Port = integer()
		     Address = {A,B,C,D} | string() | undefined
		     Dir = string()
		     Reason = term()

	      unblock_user/2 , unblock_user/3 and unblock_user/4 removes the user User from the list of blocked users for the Port (and Dir) spec-
	      ified.

THE SECURITYCALLBACKMODULE

       The  SecurityCallbackModule is a user written module that can receive events from the mod_security Erlang Webserver API module. This module
       only exports the function(s), event/4,5 , which are described below.

EXPORTS

       event(What, Port, Dir, Data) -> ignored
       event(What, Address, Port, Dir, Data) -> ignored

	      Types  What = atom()
		     Port = integer()
		     Address = {A,B,C,D} | string() <v>Dir = string()
		     Data = [Info]
		     Info = {Name, Value}

	      event/4 or event/4 is called whenever an event occurs in the mod_security Erlang Webserver API module ( event/4 is called if Address
	      is  undefined and event/5 otherwise). The What argument specifies the type of event that has occurred, and should be one of the fol-
	      lowing reasons; auth_fail (a failed user authentication), user_block (a user is being blocked from access) or user_unblock  (a  user
	      is being removed from the block list).

   Note:
       Note that the user_unblock event is not triggered when a user is removed from the block list explicitly using the unblock_user function.

Ericsson AB							    inets 5.5.2 						mod_security(3erl)
Man Page