org.miloss.fgsms.services.pcs.impl

Class PCS4jBean

java.lang.Object

org.miloss.fgsms.services.pcs.impl.PCS4jBean

All Implemented Interfaces:

PCS

public class PCS4jBean
extends Object
implements PCS

fgsms's Policy Configuration Service This web service provides one of the core functions of fgsms, managing service policies, access control and general configuration elements of the agents and fgsms itself. All methods require a classification level and process access control rules accept for GetGlobalPolicy, which actually contains little information other than the current configuration level.

Author:

AO

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	log
static String	UNSPECIFIED

Constructor Summary

Constructors

Modifier	Constructor and Description
	PCS4jBean()
protected	PCS4jBean(WebServiceContext ct) constructor used for unit testing, do not remove

Method Summary

Methods

Modifier and Type	Method and Description
ClearCredentialsResponseMsg	clearCredentials(ClearCredentialsRequestMsg request) removes authentication credentials for a specific service, typically used for connecting and obtaining status information only requires write access permissions to the specified url As of RC6
CreateAgentActionResponseMsg	createAgentAction(CreateAgentActionRequestMsg request) creates a new administrative action for an agent to perform.
DeleteAgentActionsResponseMsg	deleteAgentActions(DeleteAgentActionsRequestMsg request) deletes a list of administrative action for an agent to perform.
DeleteServicePolicyResponseMsg	deleteServicePolicy(DeleteServicePolicyRequestMsg request) Deletes a service policy to the configuration database and optionally, performance data Required Permission: administer
ElevateSecurityLevelResponseMsg	elevateSecurityLevel(ElevateSecurityLevelRequestMsg request) Elevate the security classification level of fgsms
GetAdministratorsResponseMsg	getAdministrators(GetAdministratorsRequestMsg request) Returns a list of users with the global admin role
GetAgentActionsByMachineResponseMsg	getAgentActionsByMachine(GetAgentActionsByMachineRequestMsg request) returns a list of all administrative action for an agent to perform by machine.
GetAgentPrinicplesResponseMsg	getAgentPrinicples(GetAgentPrinicplesRequestMsg request) returns a list of all user principles with the agent role, these are the service level users that are allowed to request and set new service policies and to add data to fgsms via the DCS
GetAlertRegistrationsResponseMsg	getAlertRegistrations(GetAlertRegistrationsRequestMsg request) returns a list of SLAs that I am subscribed to
GetAvailableAlertRegistrationsResponseMsg	getAvailableAlertRegistrations(GetAvailableAlertRegistrationsRequestMsg request) returns a list of all SLAs that the current user can subscribe to
GetDomainListResponseMsg	getDomainList(GetDomainListRequestMsg request) provides infrastructure information, a list of all domains associated with this fgsms instance As of RC6
GetGeneralSettingsResponseMsg	getGeneralSettings(GetGeneralSettingsRequestMsg request) sets a list of all settings that are used for fgsmss services requires global admin rights or agent As of RC6
GetGlobalPolicyResponseMsg	getGlobalPolicy(GetGlobalPolicyRequestMsg request) requires the global policy values required permission: none can't be null, class level should be specified but can be null
GetMachinesByDomainResponseMsg	getMachinesByDomain(GetMachinesByDomainRequestMsg request) provides infrastructure information, a list of all known hostnames associated with this fgsms instance As of RC6
GetMailSettingsResponseMsg	getMailSettings(GetMailSettingsRequestMsg request) gets mail settings that are used to deliver email for SLA alerts
GetMonitoredItemsByMachineResponseMsg	getMonitoredItemsByMachine(GetMonitoredItemsByMachineRequestMsg request) provides infrastructure information, a list of all known processes associated with a given hostname requires agent rights As of RC6
GetMyEmailAddressResponseMsg	getMyEmailAddress(GetMyEmailAddressRequestMsg request) Get my email address
GetOperatingStatusResponseMessage	getOperatingStatus(GetOperatingStatusRequestMessage request) Get the operating status of this service
GetPluginHtmlFormattedDisplayResponseMsg	getPluginHtmlFormattedDisplay(GetPluginHtmlFormattedDisplayRequestMsg request) Gets Html Formatted display of a given instance of a plugin, since 6.3
GetPluginInformationResponse	getPluginInformation(GetPluginInformation parameters) Gets detailed information about a plugin, since 6.3 Permissions: all authenticated users
GetPluginListResponse	getPluginList(GetPluginList parameters) Gets the current plugin list Permissions: All authenticated users
GetProcessesListByMachineResponseMsg	getProcessesListByMachine(GetProcessesListByMachineRequestMsg request) provides infrastructure information, a list of all known processes associated with a given hostname requires global admin rights As of RC6
GetServicePermissionsResponseMsg	getServicePermissions(GetServicePermissionsRequestMsg request) Returns the permission set from a service object Required Permission: read
ServicePolicyResponseMsg	getServicePolicy(ServicePolicyRequestMsg request) GetServicePolicy returns a policy for a specific service Each policy has a type (Service Policy is abstract) ServicePolicy itself has a wide range of settings that are common to all service policy types.
GetUDDIDataPublishServicePoliciesResponseMsg	getUDDIDataPublishServicePolicies(GetUDDIDataPublishServicePoliciesRequestMsg request) GetServicePolicy returns a list of service policies for all services that are configured to data publication to any federation target Note: Only information pretaining to uddi publication is returned, other data such as SLA or UserIdentification policies are not returned.
RegisterPluginResponse	registerPlugin(RegisterPlugin parameters) Registers the existence of a new plugin.
RemoveGeneralSettingsResponseMsg	removeGeneralSettings(RemoveGeneralSettingsRequestMsg request) removes 1 or more specific settings, previous values are discarded requires global admin rights As of RC6
SetAdministratorResponseMsg	setAdministrator(SetAdministratorRequestMsg request) Sets a list of users with the global admin role All previous entries are removed
SetAgentPrinicplesResponseMsg	setAgentPrinicples(SetAgentPrinicplesRequestMsg request) seta list of all user principles with the agent role, these are the service level users that are allowed to request and set new service policies and to add data to fgsms via the DCS all previous records are replaced
SetAlertRegistrationsResponseMsg	setAlertRegistrations(SetAlertRegistrationsRequestMsg request) sets a list of SLAs that I am subscribed to
SetCredentialsResponseMsg	setCredentials(SetCredentialsRequestMsg request) sets authentication credentials for a specific service, typically used for connecting and obtaining status information only requires write access permissions to the specified url As of RC6
SetGeneralSettingsResponseMsg	setGeneralSettings(SetGeneralSettingsRequestMsg request) set 1 or more specific settings, previous values are overwritten, values not specified in the request, if present, remain represent requires global admin rights As of RC6
SetGlobalPolicyResponseMsg	setGlobalPolicy(SetGlobalPolicyRequestMsg request) Sets the global policy values Required permission: global admin role
SetMailSettingsResponseMsg	setMailSettings(SetMailSettingsRequestMsg request) sets a list of all settings that are used for SLA email alerts requires global admin rights
SetMyEmailAddressResponseMsg	setMyEmailAddress(SetMyEmailAddressRequestMsg request) sets my email address
SetProcessListByMachineResponseMsg	setProcessListByMachine(SetProcessListByMachineRequestMsg request) provides infrastructure information, a list of all known processes associated with a given hostname requires agent rights As of RC6
SetServicePermissionsResponseMsg	setServicePermissions(SetServicePermissionsRequestMsg request) Sets the permissions on a particular service object Removes the current permission set and replaces it with the requested permission set Required Permission: administer
SetServicePolicyResponseMsg	setServicePolicy(SetServicePolicyRequestMsg request) Saves a service policy to the configuration database Any existing policy for this service is deleted and replaced with the parameter.
UnregisterPluginResponse	unregisterPlugin(UnregisterPlugin parameter) Unregisters the existence of a plugin.
UpdateAgentActionResponseMsg	updateAgentAction(UpdateAgentActionRequestMsg request) updates a administrative action for an agent to perform.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final Logger log

UNSPECIFIED

public static final String UNSPECIFIED

See Also:

Constant Field Values

Constructor Detail

PCS4jBean

public PCS4jBean()
          throws DatatypeConfigurationException

Throws:

DatatypeConfigurationException

PCS4jBean

protected PCS4jBean(WebServiceContext ct)
             throws DatatypeConfigurationException

constructor used for unit testing, do not remove

Parameters:

ct -

Throws:

DatatypeConfigurationException

Method Detail

getServicePolicy

@RequestWrapper(localName="GetServicePolicy",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetServicePolicy")
@ResponseWrapper(localName="GetServicePolicyResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetServicePolicyResponse")
public ServicePolicyResponseMsg getServicePolicy(ServicePolicyRequestMsg request)
                                          throws AccessDeniedException,
                                                 ServiceUnavailableException

GetServicePolicy returns a policy for a specific service Each policy has a type (Service Policy is abstract) ServicePolicy itself has a wide range of settings that are common to all service policy types. Concrete policies extend from ServicePolicy Default Data retension (dataTTL) = 30 days,set by the General Settings parameters All other defaults also come from General Settings collection Required Permission:

• If the policy exists, Read for non-agent credentials,
• If the policy exists, agent credentials can view any policy
• If the policy doesn't exists, non-agent credentials will return a null policy
• If the policy doesn't exists, global administrator credentials will return a new policy. In this case, input parameters of domain, machine name, and policy type are required
• If the policy does not exist, agent credentials, then a new policy will be created with the default parameters. In this case, input parameters of domain, machine name, and policy type are required

Specified by:

getServicePolicy in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.ServicePolicyResponseMsg

Throws:

ServiceUnavailableException

AccessDeniedException

getUDDIDataPublishServicePolicies

@RequestWrapper(localName="GetUDDIDataPublishServicePolicies",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetUDDIDataPublishServicePolicies")
@ResponseWrapper(localName="GetUDDIDataPublishServicePoliciesResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetUDDIDataPublishServicePoliciesResponse")
public GetUDDIDataPublishServicePoliciesResponseMsg getUDDIDataPublishServicePolicies(GetUDDIDataPublishServicePoliciesRequestMsg request)
                                                                               throws AccessDeniedException,
                                                                                      ServiceUnavailableException

GetServicePolicy returns a list of service policies for all services that are configured to data publication to any federation target Note: Only information pretaining to uddi publication is returned, other data such as SLA or UserIdentification policies are not returned.

Specified by:

getUDDIDataPublishServicePolicies in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.GetUDDIDataPublishServicePoliciesResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

setServicePolicy

@RequestWrapper(localName="SetServicePolicy",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.SetServicePolicy")
@ResponseWrapper(localName="SetServicePolicyResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.SetServicePolicyResponse")
public SetServicePolicyResponseMsg setServicePolicy(SetServicePolicyRequestMsg request)
                                             throws AccessDeniedException,
                                                    ServiceUnavailableException

Saves a service policy to the configuration database Any existing policy for this service is deleted and replaced with the parameter. User Permissions are not affected Required Permission: write Special Note: when setting the policy on an item contains SLAAction Restart or RunScript, Administrative permissions are required

Specified by:

setServicePolicy in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.SetServicePolicyResponseMsg

Throws:

ServiceUnavailableException

AccessDeniedException

setGlobalPolicy

@RequestWrapper(localName="SetGlobalPolicy",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.SetGlobalPolicy")
@ResponseWrapper(localName="SetGlobalPolicyResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.SetGlobalPolicyResponse")
public SetGlobalPolicyResponseMsg setGlobalPolicy(SetGlobalPolicyRequestMsg request)
                                           throws AccessDeniedException,
                                                  ServiceUnavailableException

Sets the global policy values Required permission: global admin role

Specified by:

setGlobalPolicy in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.SetGlobalPolicyResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

getGlobalPolicy

@RequestWrapper(localName="GetGlobalPolicy",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetGlobalPolicy")
@ResponseWrapper(localName="GetGlobalPolicyResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetGlobalPolicyResponse")
public GetGlobalPolicyResponseMsg getGlobalPolicy(GetGlobalPolicyRequestMsg request)
                                           throws AccessDeniedException,
                                                  ServiceUnavailableException

requires the global policy values required permission: none can't be null, class level should be specified but can be null

Specified by:

getGlobalPolicy in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.GetGlobalPolicyResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

deleteServicePolicy

@RequestWrapper(localName="DeleteServicePolicy",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.DeleteServicePolicy")
@ResponseWrapper(localName="DeleteServicePolicyResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.DeleteServicePolicyResponse")
public DeleteServicePolicyResponseMsg deleteServicePolicy(DeleteServicePolicyRequestMsg request)
                                                   throws AccessDeniedException,
                                                          ServiceUnavailableException

Deletes a service policy to the configuration database and optionally, performance data Required Permission: administer

Specified by:

deleteServicePolicy in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.DeleteServicePolicyResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

setServicePermissions

@RequestWrapper(localName="SetServicePermissions",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.SetServicePermissions")
@ResponseWrapper(localName="SetServicePermissionsResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.SetServicePermissionsResponse")
public SetServicePermissionsResponseMsg setServicePermissions(SetServicePermissionsRequestMsg request)
                                                       throws AccessDeniedException,
                                                              ServiceUnavailableException

Sets the permissions on a particular service object Removes the current permission set and replaces it with the requested permission set Required Permission: administer

Specified by:

setServicePermissions in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.SetServicePermissionsResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

getServicePermissions

@RequestWrapper(localName="GetServicePermissions",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetServicePermissions")
@ResponseWrapper(localName="GetServicePermissionsResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetServicePermissionsResponse")
public GetServicePermissionsResponseMsg getServicePermissions(GetServicePermissionsRequestMsg request)
                                                       throws AccessDeniedException,
                                                              ServiceUnavailableException

Returns the permission set from a service object Required Permission: read

Specified by:

getServicePermissions in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.GetServicePermissionsResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

getAdministrators

@RequestWrapper(localName="GetAdministrators",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetAdministrators")
@ResponseWrapper(localName="GetAdministratorsResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetAdministratorsResponse")
public GetAdministratorsResponseMsg getAdministrators(GetAdministratorsRequestMsg request)
                                               throws AccessDeniedException,
                                                      ServiceUnavailableException

Returns a list of users with the global admin role

Specified by:

getAdministrators in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.GetAdministratorsResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

setAdministrator

@RequestWrapper(localName="SetAdministrator",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.SetAdministrator")
@ResponseWrapper(localName="SetAdministratorResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.SetAdministratorResponse")
public SetAdministratorResponseMsg setAdministrator(SetAdministratorRequestMsg request)
                                             throws AccessDeniedException,
                                                    ServiceUnavailableException

Sets a list of users with the global admin role All previous entries are removed

Specified by:

setAdministrator in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.SetAdministratorResponseMsg

Throws:

ServiceUnavailableException

AccessDeniedException

elevateSecurityLevel

@RequestWrapper(localName="ElevateSecurityLevel",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.ElevateSecurityLevel")
@ResponseWrapper(localName="ElevateSecurityLevelResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.ElevateSecurityLevelResponse")
public ElevateSecurityLevelResponseMsg elevateSecurityLevel(ElevateSecurityLevelRequestMsg request)
                                                     throws AccessDeniedException,
                                                            ServiceUnavailableException

Elevate the security classification level of fgsms

Specified by:

elevateSecurityLevel in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.ElevateSecurityLevelResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

getMyEmailAddress

@RequestWrapper(localName="GetMyEmailAddress",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetMyEmailAddress")
@ResponseWrapper(localName="GetMyEmailAddressResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetMyEmailAddressResponse")
public GetMyEmailAddressResponseMsg getMyEmailAddress(GetMyEmailAddressRequestMsg request)
                                               throws AccessDeniedException,
                                                      ServiceUnavailableException

Get my email address

Specified by:

getMyEmailAddress in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.GetMyEmailAddressResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

setMyEmailAddress

@RequestWrapper(localName="SetMyEmailAddress",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.SetMyEmailAddress")
@ResponseWrapper(localName="SetMyEmailAddressResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.SetMyEmailAddressResponse")
public SetMyEmailAddressResponseMsg setMyEmailAddress(SetMyEmailAddressRequestMsg request)
                                               throws AccessDeniedException,
                                                      ServiceUnavailableException

sets my email address

Specified by:

setMyEmailAddress in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.SetMyEmailAddressResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

setAlertRegistrations

@RequestWrapper(localName="SetAlertRegistrations",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.SetAlertRegistrations")
@ResponseWrapper(localName="SetAlertRegistrationsResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.SetAlertRegistrationsResponse")
public SetAlertRegistrationsResponseMsg setAlertRegistrations(SetAlertRegistrationsRequestMsg request)
                                                       throws AccessDeniedException,
                                                              ServiceUnavailableException

sets a list of SLAs that I am subscribed to

Specified by:

setAlertRegistrations in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.SetAlertRegistrationsResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

getAlertRegistrations

@RequestWrapper(localName="GetAlertRegistrations",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetAlertRegistrations")
@ResponseWrapper(localName="GetAlertRegistrationsResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetAlertRegistrationsResponse")
public GetAlertRegistrationsResponseMsg getAlertRegistrations(GetAlertRegistrationsRequestMsg request)
                                                       throws AccessDeniedException,
                                                              ServiceUnavailableException

returns a list of SLAs that I am subscribed to

Specified by:

getAlertRegistrations in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.GetAlertRegistrationsResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

getAvailableAlertRegistrations

@RequestWrapper(localName="GetAvailableAlertRegistrations",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetAvailableAlertRegistrations")
@ResponseWrapper(localName="GetAvailableAlertRegistrationsResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetAvailableAlertRegistrationsResponse")
public GetAvailableAlertRegistrationsResponseMsg getAvailableAlertRegistrations(GetAvailableAlertRegistrationsRequestMsg request)
                                                                         throws AccessDeniedException,
                                                                                ServiceUnavailableException

returns a list of all SLAs that the current user can subscribe to

Specified by:

getAvailableAlertRegistrations in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.GetAvailableAlertRegistrationsResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

getAgentPrinicples

@RequestWrapper(localName="GetAgentPrinicples",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetAgentPrinicples")
@ResponseWrapper(localName="GetAgentPrinicplesResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetAgentPrinicplesResponse")
public GetAgentPrinicplesResponseMsg getAgentPrinicples(GetAgentPrinicplesRequestMsg request)
                                                 throws AccessDeniedException,
                                                        ServiceUnavailableException

returns a list of all user principles with the agent role, these are the service level users that are allowed to request and set new service policies and to add data to fgsms via the DCS

Specified by:

getAgentPrinicples in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.GetAgentPrinicplesResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

setAgentPrinicples

@RequestWrapper(localName="SetAgentPrinicples",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.SetAgentPrinicples")
@ResponseWrapper(localName="SetAgentPrinicplesResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.SetAgentPrinicplesResponse")
public SetAgentPrinicplesResponseMsg setAgentPrinicples(SetAgentPrinicplesRequestMsg request)
                                                 throws AccessDeniedException,
                                                        ServiceUnavailableException

seta list of all user principles with the agent role, these are the service level users that are allowed to request and set new service policies and to add data to fgsms via the DCS all previous records are replaced

Specified by:

setAgentPrinicples in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.SetAgentPrinicplesResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

getMailSettings

@RequestWrapper(localName="GetMailSettings",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetMailSettings")
@ResponseWrapper(localName="GetMailSettingsResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetMailSettingsResponse")
public GetMailSettingsResponseMsg getMailSettings(GetMailSettingsRequestMsg request)
                                           throws AccessDeniedException,
                                                  ServiceUnavailableException

gets mail settings that are used to deliver email for SLA alerts

Specified by:

getMailSettings in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.GetMailSettingsResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

setMailSettings

@RequestWrapper(localName="SetMailSettings",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.SetMailSettings")
@ResponseWrapper(localName="SetMailSettingsResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.SetMailSettingsResponse")
public SetMailSettingsResponseMsg setMailSettings(SetMailSettingsRequestMsg request)
                                           throws AccessDeniedException,
                                                  ServiceUnavailableException

sets a list of all settings that are used for SLA email alerts requires global admin rights

Specified by:

setMailSettings in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.SetMailSettingsResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

getGeneralSettings

@RequestWrapper(localName="GetGeneralSettings",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetGeneralSettings")
@ResponseWrapper(localName="GetGeneralSettingsResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetGeneralSettingsResponse")
public GetGeneralSettingsResponseMsg getGeneralSettings(GetGeneralSettingsRequestMsg request)
                                                 throws AccessDeniedException,
                                                        ServiceUnavailableException

sets a list of all settings that are used for fgsmss services requires global admin rights or agent As of RC6

Specified by:

getGeneralSettings in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.GetGeneralSettingsResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

setGeneralSettings

@RequestWrapper(localName="SetGeneralSettings",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.SetGeneralSettings")
@ResponseWrapper(localName="SetGeneralSettingsResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.SetGeneralSettingsResponse")
public SetGeneralSettingsResponseMsg setGeneralSettings(SetGeneralSettingsRequestMsg request)
                                                 throws AccessDeniedException,
                                                        ServiceUnavailableException

set 1 or more specific settings, previous values are overwritten, values not specified in the request, if present, remain represent requires global admin rights As of RC6

Specified by:

setGeneralSettings in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.SetGeneralSettingsResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

removeGeneralSettings

@RequestWrapper(localName="RemoveGeneralSettings",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.RemoveGeneralSettings")
@ResponseWrapper(localName="RemoveGeneralSettingsResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.RemoveGeneralSettingsResponse")
public RemoveGeneralSettingsResponseMsg removeGeneralSettings(RemoveGeneralSettingsRequestMsg request)
                                                       throws AccessDeniedException,
                                                              ServiceUnavailableException

removes 1 or more specific settings, previous values are discarded requires global admin rights As of RC6

Specified by:

removeGeneralSettings in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.RemoveGeneralSettingsResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

setCredentials

@RequestWrapper(localName="SetCredentials",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.SetCredentials")
@ResponseWrapper(localName="SetCredentialsResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.SetCredentialsResponse")
public SetCredentialsResponseMsg setCredentials(SetCredentialsRequestMsg request)
                                         throws AccessDeniedException,
                                                ServiceUnavailableException

sets authentication credentials for a specific service, typically used for connecting and obtaining status information only requires write access permissions to the specified url As of RC6

Specified by:

setCredentials in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.SetCredentialsResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

clearCredentials

@RequestWrapper(localName="ClearCredentials",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.ClearCredentials")
@ResponseWrapper(localName="ClearCredentialsResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.ClearCredentialsResponse")
public ClearCredentialsResponseMsg clearCredentials(ClearCredentialsRequestMsg request)
                                             throws AccessDeniedException,
                                                    ServiceUnavailableException

removes authentication credentials for a specific service, typically used for connecting and obtaining status information only requires write access permissions to the specified url As of RC6

Specified by:

clearCredentials in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.ClearCredentialsResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

getDomainList

@RequestWrapper(localName="GetDomainList",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetDomainList")
@ResponseWrapper(localName="GetDomainListResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetDomainListResponse")
public GetDomainListResponseMsg getDomainList(GetDomainListRequestMsg request)
                                       throws AccessDeniedException,
                                              ServiceUnavailableException

provides infrastructure information, a list of all domains associated with this fgsms instance As of RC6

Specified by:

getDomainList in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.GetDomainListResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

getMachinesByDomain

@RequestWrapper(localName="GetMachinesByDomain",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetMachinesByDomain")
@ResponseWrapper(localName="GetMachinesByDomainResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetMachinesByDomainResponse")
public GetMachinesByDomainResponseMsg getMachinesByDomain(GetMachinesByDomainRequestMsg request)
                                                   throws AccessDeniedException,
                                                          ServiceUnavailableException

provides infrastructure information, a list of all known hostnames associated with this fgsms instance As of RC6

Specified by:

getMachinesByDomain in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.GetMachinesByDomainResponseMsg

Throws:

ServiceUnavailableException

AccessDeniedException

getProcessesListByMachine

@RequestWrapper(localName="GetProcessesListByMachine",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetProcessesListByMachine")
@ResponseWrapper(localName="GetProcessesListByMachineResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetProcessesListByMachineResponse")
public GetProcessesListByMachineResponseMsg getProcessesListByMachine(GetProcessesListByMachineRequestMsg request)
                                                               throws AccessDeniedException,
                                                                      ServiceUnavailableException

provides infrastructure information, a list of all known processes associated with a given hostname requires global admin rights As of RC6

Specified by:

getProcessesListByMachine in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.GetProcessesListByMachineResponseMsg

Throws:

ServiceUnavailableException

AccessDeniedException

setProcessListByMachine

@RequestWrapper(localName="SetProcessListByMachine",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.SetProcessListByMachine")
@ResponseWrapper(localName="SetProcessListByMachineResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.SetProcessListByMachineResponse")
public SetProcessListByMachineResponseMsg setProcessListByMachine(SetProcessListByMachineRequestMsg request)
                                                           throws AccessDeniedException,
                                                                  ServiceUnavailableException

provides infrastructure information, a list of all known processes associated with a given hostname requires agent rights As of RC6

Specified by:

setProcessListByMachine in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.SetProcessListByMachineResponseMsg

Throws:

ServiceUnavailableException

AccessDeniedException

getMonitoredItemsByMachine

@RequestWrapper(localName="GetMonitoredItemsByMachine",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetMonitoredItemsByMachine")
@ResponseWrapper(localName="GetMonitoredItemsByMachineResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetMonitoredItemsByMachineResponse")
public GetMonitoredItemsByMachineResponseMsg getMonitoredItemsByMachine(GetMonitoredItemsByMachineRequestMsg request)
                                                                 throws AccessDeniedException,
                                                                        ServiceUnavailableException

provides infrastructure information, a list of all known processes associated with a given hostname requires agent rights As of RC6

Specified by:

getMonitoredItemsByMachine in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.GetMonitoredItemsByMachineResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

getOperatingStatus

@RequestWrapper(localName="GetOperatingStatus",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:common",
                className="org.miloss.fgsms.services.interfaces.common.GetOperatingStatus")
@ResponseWrapper(localName="GetOperatingStatusResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:common",
                 className="org.miloss.fgsms.services.interfaces.common.GetOperatingStatusResponse")
public GetOperatingStatusResponseMessage getOperatingStatus(GetOperatingStatusRequestMessage request)

Get the operating status of this service

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.common.GetOperatingStatusResponseMessage

getAgentActionsByMachine

public GetAgentActionsByMachineResponseMsg getAgentActionsByMachine(GetAgentActionsByMachineRequestMsg request)
                                                             throws AccessDeniedException,
                                                                    ServiceUnavailableException

returns a list of all administrative action for an agent to perform by machine. Only applies to machine policy items, requires agent or global administrative rights. As of 6.3

Specified by:

getAgentActionsByMachine in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.GetAgentActionsByMachineResponseMsg

Throws:

ServiceUnavailableException

AccessDeniedException

updateAgentAction

@RequestWrapper(localName="UpdateAgentAction",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.UpdateAgentAction")
@ResponseWrapper(localName="UpdateAgentActionResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.UpdateAgentActionResponse")
public UpdateAgentActionResponseMsg updateAgentAction(UpdateAgentActionRequestMsg request)
                                               throws AccessDeniedException,
                                                      ServiceUnavailableException

updates a administrative action for an agent to perform. Only applies to machine policy items, requires agent rights. As of 6.3

Specified by:

updateAgentAction in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.UpdateAgentActionResponseMsg

Throws:

ServiceUnavailableException

AccessDeniedException

deleteAgentActions

@RequestWrapper(localName="DeleteAgentActions",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.DeleteAgentActions")
@ResponseWrapper(localName="DeleteAgentActionsResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.DeleteAgentActionsResponse")
public DeleteAgentActionsResponseMsg deleteAgentActions(DeleteAgentActionsRequestMsg request)
                                                 throws AccessDeniedException,
                                                        ServiceUnavailableException

deletes a list of administrative action for an agent to perform. Only applies to machine policy items, requires global administrative rights. actions must be in the completed state As of 6.3

Specified by:

deleteAgentActions in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.DeleteAgentActionsResponseMsg

Throws:

ServiceUnavailableException

AccessDeniedException

createAgentAction

@RequestWrapper(localName="CreateAgentAction",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.CreateAgentAction")
@ResponseWrapper(localName="CreateAgentActionResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.CreateAgentActionResponse")
public CreateAgentActionResponseMsg createAgentAction(CreateAgentActionRequestMsg request)
                                               throws AccessDeniedException,
                                                      ServiceUnavailableException

creates a new administrative action for an agent to perform. Only applies to machine policy items, requires global administrative rights As of 6.3

Specified by:

createAgentAction in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.CreateAgentActionResponseMsg

Throws:

ServiceUnavailableException

AccessDeniedException

registerPlugin

public RegisterPluginResponse registerPlugin(RegisterPlugin parameters)
                                      throws AccessDeniedException,
                                             ServiceUnavailableException

Registers the existence of a new plugin. Note: this does not actually copy files to the server(s) Permissions: global administrators only

Specified by:

registerPlugin in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.RegisterPluginResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

unregisterPlugin

public UnregisterPluginResponse unregisterPlugin(UnregisterPlugin parameter)
                                          throws AccessDeniedException,
                                                 ServiceUnavailableException

Unregisters the existence of a plugin. Plugins cannot be unregistered if they are currently referenced from an existing policy. Note: this does not actually remove files to the server(s) Permissions: global administrators only

Specified by:

unregisterPlugin in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.UnregisterPluginResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

getPluginList

public GetPluginListResponse getPluginList(GetPluginList parameters)

Gets the current plugin list Permissions: All authenticated users

Specified by:

getPluginList in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.GetPluginListResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

getPluginInformation

public GetPluginInformationResponse getPluginInformation(GetPluginInformation parameters)
                                                  throws AccessDeniedException,
                                                         ServiceUnavailableException

Gets detailed information about a plugin, since 6.3 Permissions: all authenticated users

Specified by:

getPluginInformation in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.GetPluginInformationResponseMsg

Throws:

ServiceUnavailableException

AccessDeniedException

getPluginHtmlFormattedDisplay

@RequestWrapper(localName="GetPluginHtmlFormattedDisplay",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetPluginHtmlFormattedDisplay")
@ResponseWrapper(localName="GetPluginHtmlFormattedDisplayResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:policyConfiguration",
                 className="org.miloss.fgsms.services.interfaces.policyconfiguration.GetPluginHtmlFormattedDisplayResponse")
public GetPluginHtmlFormattedDisplayResponseMsg getPluginHtmlFormattedDisplay(GetPluginHtmlFormattedDisplayRequestMsg request)
                                                                       throws AccessDeniedException,
                                                                              ServiceUnavailableException

Gets Html Formatted display of a given instance of a plugin, since 6.3

Specified by:

getPluginHtmlFormattedDisplay in interface PCS

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.policyconfiguration.GetPluginHtmlFormattedDisplayResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException