Service Control Application Suite for Broadband API プログラマ ガイド

EngageAPI

クライアント プログラムがシステムのハードウェアおよびソフトウェアに接続できるようにします。ネットワーク接続機能を実行する、エレメント管理作業の出発点です。

SCAS PolicyAPI

サービス コンフィギュレーションを管理します。

import com.cisco.apps.scas.*;

import com.cisco.apps.scas.common.*;

import com.cisco.apps.scas.policy.*;

String username = "admin";

String password = "pcube";

String se = "212.47.174.32";

Connection connection = null;

try{

connection = Engage.login(se, user, password, Connection.SE_DEVICE);

}catch (ConnectionFailedException e)

{

// login failed - handle exception

}

Engage.logout(connection);

// retrieve a service configuration

Policy myPolicy =

PolicyAPI.retrievePolicy(connection);

// apply a policy

PolicyAPI.applyPolicy (connection, myPolicy, SCAS.APPLY_FLAG_OVERWRITE);

String filename = "policy.pqb";

BufferedReader br =
new BufferedReader(new InputStreamReader(new FileInputStream(filename)));

Policy importedPolicy =
ImportExportUtils.importPolicy(ImportExportUtils.XML_FORMATTER, br);

String filename = "policy.pqb";

PrintStream print = new PrintStream(new FileOutputStream(new File(filename)));

ImportExportUtils.exportPolicy(policy, ImportExportUtils.XML_FORMATTER, print);

Policy myPolicy = new Policy("");

. . .

String name = " Offensive Content Website List ";

String description = " A list of offensive website hosts. ";

HostList offensiveList = new HostList(name, description);

try

{

offensiveList.add(new HostListItem("www.offensive-content.com"));

offensiveList.add(new HostListItem("www.more-offensive-content.com"));

} catch(DuplicateItemException e)

{

// handle duplicate exception

}

ListArray listArray = myPolicy.getListArray();

try

{

listArray.addList(offensiveList);

} catch(DuplicateItemException e)

{

// handle duplicate exception

}

ListArray listArray = myPolicy.getListArray();

for (int i = 0; i < listArray.getSize(); i++)

{

Object o = listArray.getElementAt(i);

}

if (o instanceof HostList)

{

HostList hostlist = (HostList) o;

System.out.println("Host List");

} else // IPRangeList

{

IPRangeList iplist = (IPRangeList) o;

System.out.println("IP Range List");

}

// To add a new host list item

hostlist.add(new HostListItem("www.cnn.com"));

// create a new protocol and pass it a reference to a service configuration

Protocol quakeProtocol = new Protocol(myPolicy);

// set the protocol name

try

{

quakeProtocol.setName("quake");

} catch(DuplicateException de)

{

//a Protocol with such a name already exists in the service configuration

// handle exception

} catch(ItemNotFoundException infe)

{

//item was missing while validating rename: service configuration corrupt

// handle exception

}

// add new port and transport type

try

{

quakeProtocol.add(new PortListItem(26000, Consts.TRANSPORT_TYPE_TCP));

} catch(DuplicateItemException e)

{

// the service configuration has a Protocol with such a defined port

// handle exception

}

// add the quake protocol to the service configuration 's protocol list

try

{

protocols.add(quakeProtocol);

} catch(DuplicateItemException e)]

{

// the service configuration already has this Protocol

// handle exception

}

quakeProtocol.add(new PortListItem(26000, Consts.TRANSPORT_TYPE_TCP));

protocols.add(quakeProtocol);

. . .

// get protocol list

ProtocolArray protocols = myPolicy.getProtocolList();

// get a protocol called "HTTP Browsing":

try

{

Protocol http = protocols.getProtocol ("HTTP Browsing");

} catch(ItemNotFoundException infe)

{

// the service configuration does not have a Protocol with such a name

// handle exception

}

// add port 8082 to HTTP Browsing

try

{

http.add(new PortListItem (8082, Consts.TRANSPORT_TYPE_TCP));

} catch(DuplicateItemException e)

{

// the service configuration has a Protocol with such a defined port

// handle exception

}

. . .

ProtocolArray protocols = myPolicy.getProtocolList();

Protocol http = protocols.getProtocol ("HTTP Browsing");

http.add(new PortListItem (8082, Consts.TRANSPORT_TYPE_TCP));

. . .

Service gamingService = new Service(myPolicy); // create a service

try

{

gamingService.setName("Gaming Service"); // set service name

} catch(DuplicateException de)

{

// a Service with such a name already exists in the service configuration

// handle exception

} catch(ItemNotFoundException infe)

{

//item was missing while validating rename: service configuration corrupt

// handle exception

}

// create a service element for Subscriber-Initiated Doom

try

{

gamingService.addProtocol("doom",

ServiceElement.DIRECTION_SUBSCRIBER_INITIATED);

} catch(ItemNotFoundException e)

{

// there is no such Protocol in the service configuration

// handle exception

} catch(DuplicateItemException e)

{

// there is already a Service with such a Protocol and direction in the service configuration

// handle exception

}

// create a service element for Subscriber-Initiated Quake

try

{

gamingService.addProtocol("quake",

ServiceElement.DIRECTION_SUBSCRIBER_INITIATED);

} catch(ItemNotFoundException e)

{

// there is no such Protocol in the service configuration

// handle exception

} catch(DuplicateItemException e)

{

//There is already a Service with such a Protocol and direction in the service configuration

// handle exception

}

// add service to service configuration

try

{

myPolicy.getServiceList().add(gamingService);

} catch(DuplicateItemException e)

{

//There is already a Service in the service configuration

// handle exception

}

. . .

Service gamingService = new Service (myPolicy); // create a service

gamingService.setName("Gaming Service"); // set service name

gamingService.addProtocol("doom",
ServiceElement.DIRECTION_SUBSCRIBER_INITIATED);

int listIndex =

myPolicy.getListArray().getListIndex("gaming servers list");

if(listIndex == -1)

{

// there is no such list

// handle error

}

int serviceElementIndex = gamingService.getServiceElementArray.getIndexOfItem("doom", ServiceElement. DIRECTION_SUBSCRIBER_INITIATED);

if(serviceElementIndex == -1)

{

// There is no such ServiceElement

// handle error

}

try {

gamingService.addList(serviceElementIndex,listIndex);

} catch(ItemNotFoundException e)

{

// handle error

} catch(DuplicateItemException e)

{

// handle error

}

// add service to service configuration

myPolicy.getServiceList().add(gamingService);

/* Define package 1 */

Package family = new Package(myPolicy); // create a package

try

{

family.setName("Family Package"); // set package name

} catch (DuplicateItemException e)

{

// there already is a Package in service configuration with such a name

// handle exception

}

ServiceRule serviceRule = new ServiceRule(policy);

// adding service to rule

try

{

serviceRule.setServiceName("Parental Watch Service");

} catch(ItemNotFoundException e)

{

// no such service

// handle exception

}

// get the default rule - it will apply to all the time-based rules

// since no time-based rules are created

Rule rule = serviceRule.getDefaultRule();

// set rule state to be enable

rule.setState(Rule.RULE_STATE_ENABLED);

// set rule action to be block

rule.setPreBreachAccessMode(Rule.ACCESS_BLOCK);

// get package's service rule array

ServiceRuleArray serviceRuleArray = family.getServiceRuleList();

// add service rule to the package's serviceRuleArray

try

{

serviceRuleArray.add(serviceRule);

} catch(DuplicateItemException e)

{

// there already is such a rule

// handle exception

}

/* Define package 2 */

Package bachelor = new Package(myPolicy); // create a package

try

{

bachelor.setName("Bachelor Package"); // set package name

} catch (DuplicateItemException e)

{

// there already is a Package in service configuration with such a name

// handle exception

}

serviceRule = new ServiceRule(policy);

// adding service to rule

try

{

serviceRule.setServiceName("Parental Watch Service");

} catch(ItemNotFoundException e)

{

// no such service

// handle exception

}

// get the default rule - it will apply to all the time-based rules

// since no time-based rules are created

rule = serviceRule.getDefaultRule();

// set rule state to be enable

rule.setState(Rule.RULE_STATE_ENABLED);

// set rule action to be block

rule.setPreBreachAccessMode(Rule.ACCESS_ADMIT);

// get package service rule array

serviceRuleArray = bachelor.getServiceRuleList();

// add service rule to the package's serviceRuleArray

try

{

serviceRuleArray.add(serviceRule);

} catch(DuplicateItemException e)

{

// there already is such a rule

// handle exception

}

// add the packages to the service configuration

try

{

policy.getPackageList().add(family);

policy.getPackageList().add(bachelor);

}catch(DuplicateItemException e)

{

//there are already such packages

//handle exception

}

Package family = new Package(myPolicy); // create a package

family.setName("Family Package"); // set package name

ServiceRule pw =residential.getRule("Parental Watch Service");

rule.setPreBreachAccessMode(Rule.ACCESS_ADMIT);

// create new package

Package residential = new Package(myPolicy);

// add the packages to the service configuration

try

{

policy.getPackageList().add(residential);

} catch(DuplicateItemException e)

{

// there already are such packages

// handle exception

}

// set service name

try

{

residential.setName("residential");

} catch (DuplicateItemException e)

{

// there already is a Package with such a name in service configuration

// handle exception

}

ServiceRule serviceRule = new ServiceRule(policy);

// adding service to rule

try

{

serviceRule.setServiceName("Parental Watch Service");

} catch(ItemNotFoundException e)

{

// no such service

// handle exception

}

// get the default rule - it will apply to all the time-based rules

// since no time-based rules are created

Rule rule = serviceRule.getDefaultRule();

// set rule state to be enable

rule.setState(Rule.RULE_STATE_ENABLED);

// set rule action to be admitted

rule.setPreBreachAccessMode(Rule.ACCESS_ADMIT);

// limit daily volume to approximately 100 MB

rule.setBreachVolumeLimit(100000);

// set rule post-breach action to be blocked

rule.setPostBreachAccessMode(Rule.ACCESS_BLOCK);

// generate RDR when limit is breached

rule.setBreachReportEnabled(true);

// get package service rule array

ServiceRuleArray serviceRuleArray = residential.getServiceRuleList();

// add service rule to the package's serviceRuleArray

try

{

serviceRuleArray.add(serviceRule);

} catch(DuplicateItemException e)

{

// there is already such a rule

// handle exception

}

// tell the package to use daily aggregation periods

residential.setAggregationPeriod(Package.AGGREGATED_PERIOD_DAILY);

// apply changes to the SCE Platform

PolicyAPI.applyPolicy(connection, myPolicy, SCAS.APPLY_FLAG_OVERWRITE);

// close the connection

SCAS.logout(con);

residential.setAggregationPeriod (Package.AGGREGATED_PERIOD_DAILY);

// assigning BWController number 3 to the Rule in upstream direction

ftpRule.getDefaultRule().setPreBreachUpstreamBWControllerIndex(3);

Rule.setBreachReportEnabled(true);

// set rule post-breach action to block access

rule.setPostBreachAccessMode(Rule.ACCESS_BLOCK);

. . .

// creates a new Package

Package myPackage = new Package(myPolicy);

// add the packages to the service configuration

try

{

policy.getPackageList().add(myPackage);

} catch(DuplicateItemException e)

{

// there already are such packages

// handle exception

}

// creates new service rule

ServiceRule serviceRule = new ServiceRule(policy);

// adds service to rule

serviceRule.setServiceName(serviceName);

// gets the default rule - it will apply to all time based rules

// since no time based rules are created

Rule defaultRule = serviceRule.getDefaultRule();

// set default rule state to be disable

defaultRule.setState(Rule.RULE_STATE_DISABLED);

// announce the need for configuring specific behavior to T1

Rule t1Rule = null;

Try

{

t1Rule = serviceRule.addTimeFrameRule(TimeFrame.T1);

} catch(ItemNotFoundException e)

{

// handle exception

} catch(DuplicateItemException e)

{

// handle exception

}

// set T1 rule state enabled

t1Rule.setState(Rule.RULE_STATE_ENABLED);

// adds service rule to the package's serviceRuleArray

myPackage.setServiceRule(serviceRule);

. . .

// assign the default redirect string of the "HTTP Browsing" protocol

// to be redirected to a certain URL

try

{

policy.setProtocolRedirectString("HTTP Browsing","http://www.mySite.com/redirect.html");

} catch (ItemNotFoundException e)

{

//handle exception

} catch (MalformedURLException e)

{

//handle exception

}

// creates new service rule

ServiceRule serviceRule = new ServiceRule(policy);

// adds service to rule

serviceRule.setServiceName("http browsing service");

// gets the default rule - it will apply to all time-based rules

// since no time-based rules are created

Rule defaultRule = serviceRule.getDefaultRule();

// set default rule state to be enable

defaultRule.setState(Rule.RULE_STATE_ENABLED);

// set rule post-breach action to block and redirect

defaultRule.setPostBreachAccessMode(Rule.ACCESS_BLOCK_AND_REDIRECT);